FRDP

Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin ⛏ .

Getting Started

Features

Prerequisites

• FastAPI
• PostgreSQL - postgres12
• PgAdmin
• jwt

Project setup

# clone the repo
$ git clone https://github.com/BnademOverflow/FRDP

# move to the project folder
$ cd FRDP

Creating virtual environment

• Install pipenv a global python project pip install pipenv
• Create a virtual environment for 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.sample and 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
PGADM[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:latest in 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.

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b hello/world)
3. Commit your Changes (git commit -m 'Add hello world')
4. Push to the Branch (git push origin feature/helloworld)
5. Open a Pull Request

License

This project is licensed under the terms of the Apache-2.0 License.