A simple flask API that allows a user to create projects and get bids for funding the project. It also allows a user to bid on projects, all that is needed is an email and a user name.
The live link for the app => HEROKU
Download this JSON Collection file and import it to your Postman App. It contains endpoints and data that can be used to interact with the API Sample Postman Collection with data
- Clone this repository
https://github.com/3V0L/flask-setup.git
- Navigate into directory
$ cd flask-setup
Create a virtual environment
$ python3 -m venv venv
- Rename the
.env-examplefile to.envand set your environment variables as shown in the file - After doing the above, enter the command
$ source .env
- Install the apps dependencies by running
$ pip install -r requirements.txt
- Run initial migrations
$ python manage.py db upgrade
$ python manage.py db migrate
- Run
$ python app.py
| Endpoint | Functionality | HTTP method |
|---|---|---|
| /register | register a new user | POST |
| /project/create | Create a project | POST |
| /project/delete/ | Remove a Project | DELETE |
| /project/update | Update a Project | PATCH |
| /project/my-projects | Get all my projects | GET |
| /project/get-project?id=project_id | Get a specific project | GET |
| /project/get-project | Get all active projects | GET |
| /bid/create | Creates a bid for a project | POST |
| /bid/update | Updates a bid for a project | PATCH |
| /bid/delete | Delete a bid for a project | DELETE |
| /bid/my-bids | Get all a user's bids | GET |
Command for testing
$ pytest --cov=api
Linting command
$ pycodestyle api