2.1 KiB
2.1 KiB
Contributing
We're so excited you're interested in helping with Authorizer! We are happy to help you get started, even if you don't have any previous open-source experience 😊
New to Open Source?
- Take a look at How to Contribute to an Open Source Project on GitHub
- Go thorugh the Authorizer Code of Conduct
Where to ask Questions?
- Check our Github Issues to see if someone has already answered your question.
- Join our community on Discord(TODO: coming soon) and feel free to ask us your questions
As you gain experience with authorizer, please help answer other people's questions! 🙏
What to Work On?
You can get started by taking a look at our Github issues
If you find one that looks interesting and no one else is already working on it, comment in the issue that you are going to work on it.
Please ask as many questions as you need, either directly in the issue or on Discord. We're happy to help!🙌
Contributions that are ALWAYS welcome
- More tests
- Improved Docs
- Improved error messages
- Educational content like blogs, videos, courses
Development Setup
Prerequisites
- OS: Linux or macOS or windows
- Go: (Golang)(https://golang.org/dl/) >= v1.15
Familiarize yourself with authorizer
Project Setup
- Fork the authorizer repository (Skip this step if you have access to repo)
git clone https://github.com/authorizerdev/authorizer.git
cd authorizer
mv .env.sample .env
. Check all the supported env here- Build the code
make clean && make
Note: if you don't have
make
, you cancd
intoserver
dir and build usinggo build
command - Run binary
./build/server