/23ForObiApi

Primary LanguagePythonMIT LicenseMIT

#23ForObi Core API

23 votes for PETER OBI

The goal is to deliver at least 23 votes per village within each state and with your help and the help of your loved ones, we can do this

Description

#23forobi API is an open source API that serves as the backend for 23forobi Website

Language

Python

This project relies heavily on BigFastAPI and FastAPI framework

API Documentation

A list of the endpoints and the functions they implement can be found here.

How to contribute to #23ForObi

This is an example of how you can setup your project locally. To get a local copy up and running follow these steps.

Prerequisites

Python 3.6+ or lastest version already installed on your local machine.

Clone the repo by runnng the command below

git clone https://github.com/obidient/23ForObiApi.git && cd 23ForObiApi

After Cloning the repo, follow the steps below to get it up and running

  1. Create a new python virtual environment with python3 -m venv env Depending on your system, it may be python -m venv env.
  2. Activate python virtual environment with .\env\Scripts\Activate.ps1 (Windows) or source /path/to/venv/bin/activate (linux/mac)
  3. Install your requirements file by running
pip install -r requirements.txt
  1. Create a .env file by copying the .env.sample file cp .env.sample .env
  2. You're all set! Run your project using the command
python main.py

Be sure to upgrade to the latest pip version if you have any errors.

python -m pip install --upgrade pip

Resources

Support

Join Our Whatsapp Group.