Table of Contents
Simple Rest API to manage users account, authentification and authorizations.
- python 3.11+
- pipenv
- postgreSQL
- docker
-
Clone the repo
git clone https://github.com/Spyro119/OAuth-api/
-
Install dependencies with pipenv
python -m pipenv install
-
rename
.env.templatefile for.envand update values:POSTGRES_USER=<username> POSTGRES_PASSWORD=<password> POSTGRES_SERVER=<host> POSTGRES_PORT=<port> POSTGRES_DB=<db_name> JWT_SECRET_KEY=<secret_key> JWT_REFRESH_SECRET_KEY=<secret_key> # Docker vars PGDATA=<Docker Data path> PG_CONTAINER_NAME=<Docker db container name>
-
Run the app
python -m pipenv shell # Ouvre une nouvelle instance de terminal dans l'environnement du projet. uvicorn app.main:app --reload -
Log in as admin and create your new admin account.
- Credentials are - username:
adminpassword:password123!. - IMPORTANT: It is recommended to delete this account after creating your own admin account.
- Credentials are - username:
- Project initialisation.
- Database initialised.
- Endpoints defined.
- Unit testing integration. (Partially done).
- Document the project.
See the open issues for a full list of proposed features (and known issues).
- Clone the repo
git clone - Create a new "Feature" branch (
git checkout -b feature/{FeatureName}) - Commit changes (
git commit -m 'Problème x Résolu') - Push to your own branch (
git push origin feature/{FeatureName}) - Create a Pull Request
To host the API, simply run it under docker:
docker compose up -d --build Samuel Jubinville-Baril - github - samuel.jubinville@outlook.com
Project Link: https://github.com/Spyro119/OAuth-api