This repo contains(currently) non-functional UI templates and a Flask API for the WeConnect project. A platform that brings businesses and individuals together. This platform creates awareness for businesses and gives the users the ability to write reviews about the businesses they have interacted with.
This is an Andela bootcamp project aimed at facilitating developers to learn in a more fun and productive way. I.e. doing real world projects while learning the concepts of programming. The project defination can be found here
To test the UIs install a browser of your choice. The UIs can be viewed and manually tested at joshuaondieki.github.io Alternatively, clone this repo and test the UIs locally.
- Install Python 3.6.4
- Git clone this repo.
- cd to the root dir of this repo.
- Create a virtual env and
pip install -r requirements.txt - Run the app with
python app.pyorpython3 app.py - Checkout the endpoints and test them with a tool like POSTMAN
This Flask API has been hosted to heroku at Wecon
| EndPoint | Functionality |
|---|---|
POST /api/v1/auth/register |
Creates a user account |
POST /api/v1/auth/login |
Logs in a user |
POST /api/v1/auth/logout |
Logs out a user |
POST /api/v1/auth/reset-password |
Password reset |
POST /api/v1/businesses |
Register a business |
PUT /api/v1/businesses/<businessId> |
Updates a business profile |
DELETE /api/v1//businesses/<businessId> |
Remove a business |
GET /api/v1/businesses |
Retrieves all businesses |
GET /api/v1/businesses/<businessId> |
Get a business |
POST /api/v1/businesses/<businessId>/reviews |
Add a review for a business |
GET /api/v1/businesses/<businessId>/reviews |
Get all reviews for a business |
- Joshua Ondieki
- Some credits go to fellow bootcampers, LFAs and Andela for the support and assistance.
A Pivotal tracker board was used in planning and managing this project. The board is publicly available here