B-Pump API

Backend API for the B-Pump project

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

Built With

• FastAPI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

1. Create an empty PostgreSQL database.

Installation

1. Clone the repo

   git clone https://github.com/B-Pump/bpump-api.git

2. Install PIP packages

   pip install -r requirements.txt

3. Create a .env file

   touch .env

4. Copy content of .env.example file and paste into your new .env file
5. Paste after DB_URL your database URL

Usage

• Launch the server

  uvicorn main:app --reload

Contributing

Contributions are not welcome as this is a project developed for school Olympiads. However, you can still report bugs if you find any by opening an issue. This would be greatly appreciated !

License

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

Contact

B-Pump: b.pump.project@gmail.com

Org Link: https://github.com/B-Pump