WeConnect-API-oop-

WeConnect provides 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.

Technology Used

The API has been built with:

• Flask micro-framework (Python 3.6)

UI templates

• To preview the UI, proceed to https://alexmochu.github.io .
• The UI Templates have been hosted on Github Pages

Features

• Users can be able to register and create an account

Installation

• Unsure you have installed Python3.6+, created and a activated a virtual environment.
• Clone the repo in your local machine inside the virtual environment you have created.
• Navigate to the project folder(WeConnect-API-oop-)
• Install all the requirements of the project by typing: pip install -r requirements.txt

Running the API

Type:

• export FLASK_APP=run.py
• flask run

Running the Tests

• Install Pytest : pip install pytest
• Run tests: py.test

API Endpoints

Resource URL	Methods	Description
/api/v1/auth/register	POST	User Registration
/api/v1/auth/login	POST	User Login
/api/v1/auth/reset-password	POST	Logs out User
/api/v1/auth/logout	POST	Logs out User
/api/businesses	POST	Create a business
/api/businesses	GET	Retrive all business created

UI Teplates