Comments (7)
First thing we could do, is to improve the README introduction. After reading the introduction, the following points should be clear for the audience:
- We have tooling to secure easily your express endpoints
- We have a TokenCache implementation that encapsulate the process of requesting a token and cache it until it's invalid
- If user want to use it's own cache all token related low level functions are available as well
- The oAuth flow's that we support
- You can use it with Typescript, ES6, ES5 on node and in the browser (at least how to do it with fetch).
- We should provide links that showcases how to use it to:
- Secure your REACT / Angular / whatever app login
- Make secure request from your frontend to the backend
- How to secure your backend services
- How to make safe request from service to service
So my plan is to have in the readme just an introduction, release history and migration paths.
And put the more detailed stuff to various HOWTO docs.
@bzums @Retro64 what do you think?
from authmosphere.
HOW-TOs:
- protect server endpoints with oAuth
- Request Token to communicate with oAuth protected endpoints
- Use Token Cache .....
- How to build a login with oAuth Authorization Code flow
- Mock Tooling
- Other
- TBD
from authmosphere.
I like the idea, but we should consider providing typedoc additionally
from authmosphere.
Have a look at https://github.com/zalando/zalando-howto-open-source, specifically https://github.com/zalando/zalando-howto-open-source/blob/master/READMEtemplate.md and https://github.com/noffle/art-of-readme to get some ideas about style and structure of the README/documentation
from authmosphere.
@bzums @ISO50 Should we tag it with 2.0.0, as we decided to close the ticket on 2.0.0 release?
from authmosphere.
During the course of releasing 2.0.0 we tackled some points we wanted to tackle with this ticket. Now the open issue for this ticket would be:
- add code examples and diagrams to explain OAuth 2.0 (to a certain degree) and how it can supported with this lib
from authmosphere.
We should think about concrete examples for the different configurations within the API doc
from authmosphere.
Related Issues (20)
- Fix prepublish script
- Fix linting errors
- Add .npmrc
- Update dependencies
- Update dependencies
- Update dependencies
- Decision: How to proceed with updating node-fetch to v3.x? HOT 1
- Improvement: Extend logging interface HOT 1
- [breaking] Deprecate old node versions
- Add types as true dependencies
- Update dependencies HOT 1
- Dependency updates
- Cleanup dependencies
- Resolve Dependabot alert
- bump qs from 6.5.2 to 6.5.3
- Update dependencies
- this.log is not a function
- Replace unmaintained packages
- Update dependencies
- Update dependencies
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from authmosphere.