FRDP 
Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin
Getting Started
Features
| Auth | Description |
|---|---|
| Login Access Token | OAuth2 compatible token login, get an access token for future requests |
| Check Session | Test if a user is logged in by checking if a valid access token is in the header |
| Recover Password | Password Recovery |
| Reset Password | Reset your password |
| User | Description |
|---|---|
| Create New User | Create a new user |
| Get Current User By Id | Get current user |
| Update Current User | Update own user |
| Update Other User (SuperUser) | Update a user |
| Create User (Without Authentication) | Create new user without the need to be logged in. |
Prerequisites
Project setup
# clone the repo
$ git clone https://github.com/BnademOverflow/FRDP
# move to the project folder
$ cd FRDP
Creating virtual environment
- Install
pipenva global python projectpip install pipenv - Create a
virtual environmentfor this project
# creating pipenv environment for python 3
$ pipenv --three
# activating the pipenv environment
$ pipenv shell
# if you have multiple python 3 versions installed then
$ pipenv install -d --python 3.8
# install all dependencies (include -d for installing dev dependencies)
$ pipenv install -d
Configured Enviromment
Database
- Using SQLAlchemy to Connect to our PostgreSQL Database
- Containerization The Database.
- Drop your PostgreSQL Configuration at the
.env.sampleand Don't Forget to change the Name to.env
# example of Configuration for the .env file
# Generate secret key using openssl rand -hex 32
SECRET_KEY= 4yi87D8FHRucoVyKXFUcMC/yb5YpLxz6PRX6YHm4kLU
# Email Defaut Intiger ex. 30, 60, 90
EMAIL_RESET_TOKEN_EXPIRE_HOURS= 60
# Server Default
SERVER_NAME=API
SERVER_HOST=http://localhost:8900
# Postgres default username and password
POSTGRES_USER=admin
POSTGRES_PASSWORD=admin
POSTGRES_DB=admin
POSTGRES_PORT=5500
POSTGRES_SERVER=localhost
PGADMIN_LISTEN_PORT=5050
[email protected]
PGADMIN_DEFAULT_PASSWORD=admin
Running the Application
- To run the Main we need to use uvicorn a lightning-fast ASGI server implementation, using uvloop and httptools.
# To run the Application under a reload enviromment use -- reload
$ uvicorn main:app --reload
Running the Docker Container
- We have the Dockerfile created in above section. Now, we will use the Dockerfile to create the image of the FastAPI app and then start the FastAPI app container.
docker build
- list all the docker images and you can also see the image
frdp:latestin the list.
docker images
- run the application at port 5000. The various options used are:
-p: publish the container's port to the host port.-d: run the container in the background.-i: run the container in interactive mode.-t: to allocate pseudo-TTY.--name: name of the container
docker container run -p 5000:5000 -dit --name FRDP frdp:latest
- Check the status of the docker container
docker container ps
Preconfigured Packages
Includes preconfigured packages to kick start FRDP by just setting appropriate configuration.
| Package | Usage |
|---|---|
| uvicorn | a lightning-fast ASGI server implementation, using uvloop and httptools. |
| Python-Jose | a JavaScript Object Signing and Encryption implementation in Python. |
| SQLAlchemy | is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL. |
| starlette | a lightweight ASGI framework/toolkit, which is ideal for building high performance asyncio services. |
| passlib | a password hashing library for Python 2 & 3, which provides cross-platform implementations of over 30 password hashing algorithms |
| bcrypt | Good password hashing for your software and your servers. |
| python-jose | The JavaScript Object Signing and Encryption (JOSE) technologies - JSON Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), and JSON Web Algorithms (JWA). |
| jinja2 | a very fast and easy to use stand-alone template engine for Python. |
| psycopg2 | a Python PostgreSQL database adapter. |
Contributing
- Join the FRDP Creator and Contribute to the Project if you have any enhancement or add-ons to create a good and Secure Project, Help any User to Use it in a good and simple way.
- See the open issues for a list of proposed features (and known issues) or open pull request before starting work on a new feature.
- Check also Docs for more information about FRDP.
- Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b hello/world) - Commit your Changes (
git commit -m 'Add hello world') - Push to the Branch (
git push origin feature/helloworld) - Open a Pull Request
License
This project is licensed under the terms of the Apache-2.0 License.
351 Jan 4, 2023
1 Nov 11, 2021
1.4k Jan 2, 2023
10.8k Jan 8, 2023
15 Jul 20, 2022
54 Nov 26, 2022
19 Dec 12, 2022
54 Nov 4, 2022
31 Jan 10, 2023
1 Oct 8, 2022
3 Mar 3, 2022
4 Aug 11, 2022
51 Jan 6, 2023
27 Oct 16, 2022
2 Jan 17, 2022