nazzour/fasapi-test

test with fastapi

Fasapi Test

Awesome fasapi-test created by nazzour
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
   • Using Docker
   • For development
3. Environment Variables
4. Usage
5. Contributing
6. License

About The Project

Awesome fasapi-test created by nazzour.

Installation

The first step will be to clone the repo

git clone https://github.com/nazzour/fasapi-test.git

Using Docker

Using Docker is generally recommended (but not strictly required) because it abstracts away some additional set up work.

The requirements for Docker are:

• Docker CE
• Docker Compose
  • pip install docker-compose
  • This is only a required step for linux. Docker comes bundled with docker-compose on Mac OS and Windows.

For development

The requirements are:

• Python and Poetry

1. Install the backend dependencies

   poetry install

Environment Variables

To run this project, you will need to add the following environment variables to your .env file or in the docker-compose.yaml file.

Variable	Description	Default
PROJECT_NAME	The name of the API	FastAPI
API_ENDPOINT	The endpoint of the API	/api/v1
API_PORT	The API port	8080
POSTGRES_URI	The Postgres database URI	postgresql://postgres:changeme@localhost:5432/postgres

Usage

Now you are done! You can run the project using docker-compose

docker-compose up

Or you can run the backend and frontend manually using

poetry run task start

Contributing

See CONTRIBUTING.md for ways to get started.

License

Distributed under the MIT License. See LICENSE for more information.