Project Title
OAuth-Pro
About the repository
* The repository contains various oauth methods implemented in set of
different languages and frameworks
* Each framework/language has a seperate directory under which the oauth codes are present
* Some of the standard application Oauth methods we are looking for are in any framework are
- Github
- Google
- Twitter
- LinkedIn
- Facebook
* The path to .env file on Nodejs implementations is: /OAuth-Pro/nodejs/config, with the following env vars
- GOOGLE_CLIENT_ID
- GOOGLE_CLIENT_SECRET
* To contribute to this repository read our contributions guidelines
* To raise and issue or request a feature please go through our contribution practices first.
Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Pull Request Process
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Only send your pull requests to the development branch where once we reach a stable point it will be merged with the master branch .
- Associate each Pull Request with the required issue number.
- Please provide relevant steps to use your codebase adding few extra lines of comments or commands to run would be helpful for others to follow along .
Branch Policy
- development: If you are making a contribution make sure to send your Pull Request to this branch . All developments goes in this branch.
- master: After significant features/bug-fixes are accumulated in development branch we merge it with the master branch.
Contribution Practices
- If you want to work on a particular framework/language or a particular oauth and it is not mentioned in any of the issues please raise an issue first.
- Write clear and meaningful commit messages.
- If you report a bug please provide steps to reproduce the bug.
- In case of changing the backend routes please submit an updated routes documentation for the same.
- If there is an UI related change it would be great if you could attach a screenshot with the resultant changes so it is easier to review for the maintainers
- Create a folder if not created of the required framework/language you want to work with and inside each folder create a folder with the oauth you are working . For example nodejs/github
License
With ❤️ by CodeChef-VIT