Skip to content

README.md

Latest commit

 

History

History
249 lines (176 loc) · 7.59 KB

README.md

File metadata and controls

249 lines (176 loc) · 7.59 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

OAuth-api

Rest API for user management.
Explore documentation »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contribute
  6. Versions
  7. Publis
  8. License
  9. Contact
  10. Ressources

About the project

Product Name Screen Shot

Simple Rest API to manage users account, authentification and authorizations.

(back to top)

Built with

  • Python-shield
  • FastAPI-shield

(back to top)

Getting started

Prerequisites

  • python 3.11+
  • pipenv
  • postgreSQL
  • docker

Installation

  1. Clone the repo

    git clone https://github.com/Spyro119/OAuth-api/

  2. Install dependencies with pipenv

    python -m pipenv install

  3. rename .env.template file for .env and 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>

  4. Run the app

    python -m pipenv shell # Ouvre une nouvelle instance de terminal dans l'environnement du projet.
uvicorn app.main:app --reload

  5. Log in as admin and create your new admin account.

    • Credentials are - username: admin password: password123!.
    • IMPORTANT: It is recommended to delete this account after creating your own admin account.

(back to top)

Usage

(back to top)

Roadmap

  • 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).

(back to top)

Contribute

  1. Clone the repo git clone
  2. Create a new "Feature" branch (git checkout -b feature/{FeatureName})
  3. Commit changes (git commit -m 'Problème x Résolu')
  4. Push to your own branch (git push origin feature/{FeatureName})
  5. Create a Pull Request

(back to top)

Versions

(back to top)

Publish

To host the API, simply run it under docker:

docker compose up -d --build

(back to top)

Contact

Samuel Jubinville-Baril - github - samuel.jubinville@outlook.com

Project Link: https://github.com/Spyro119/OAuth-api

(back to top)

Ressources

(back to top)