Welcome to Nile-Auth. We are glad you are interested in contributing to this project. We welcome contributions of all kinds, including bug reports, feature requests, code improvements, and documentation updates.
@nile-auth/server: a Next.js app for serving REST APIs@nile-auth/query: a small wrapper around pg node to make querying easier@nile-auth/core: a small wrapper around NextAuth(https://next-auth.js.org/) which connects to a Nile database
Each package/app is 100% TypeScript.
We use yarn (please avoid npm) and Turborepo for managing dependencies and builds.
You can read a more detailed guide in our documentation
-
Fork the Repository
Click the "Fork" button on GitHub to create your own copy of the repo. -
Clone the Repo
git clone https://github.com/your-username/nile-auth.git cd nile-auth -
Install Dependencies
yarn install
-
Run the Development Server
yarn dev
Whether you run into issues with Nile Auth itself or while attempting to contribute, we are here for you.
- GitHub Issues – Report bugs or request features in our discussion board.
- Discord – Join our developer community here.
If you run into security issues, we prefer you contact support@thenile.dev privately. We'll look into it with priority and give you full credit for discovery.
- Feature Requests & Issues: Open a GitHub issue to discuss before starting work.
- Pull Requests:
- Create a feature branch (
git checkout -b feature/your-feature). - Follow existing code style and linting rules.
- Add tests where applicable.
- Submit a PR with a clear description.
- Create a feature branch (
- Code of Conduct: Be respectful and constructive in discussions.
Review our testing guide for suggestions on how to test Nile Auth.
Happy coding! 🚀