Skip to main content

Pre-requisites

There are some things you'll need to do before you can start contributing to Auth-N. This guide will help you set up your development environment to contribute to the project.

Requirements​

Before you start contributing to Auth-N, you need to be familiar with the following:

  • Git and GitHub
  • Python 3.10 or higher (We recommend using 3.12)
  • Pythons virtual environment (venv)
  • IDE or code editor of your choice (We recommend using Visual Studio Code)
  • Docker and Docker Compose (Not required but recommended)
  • Basic to intermediate knowledge of programming in Python like: (Just to name a few)
    • Writing functions, classes, and modules
    • Using libraries and packages
    • Writing tests using the unittest module
    • Handling exceptions, errors, and logging
    • Using the FastAPI library for building APIs
    • Using decorators and context managers
    • Understanding the basics of object-oriented programming
    • Using the Pydantic library for data validation and serialization
    • Understanding the SQLAlchemy ORM for database operations
Tip

If you are not familiar with any of the above, there are many other things you can do to contribute to the project. You can help with documentation, testing, or even just by reporting bugs. Feel free to reach out to us if you need help.