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 and API Documentation

• To preview the UI, proceed to https://alexmochu.github.io .
• The UI Templates have been hosted on Github Pages
• To access the API hosted on the Heroku cloud platform -->> https://weconnect-v1-api-heroku.herokuapp.com/
• Access the API documentation at "https://weconnectapiv1.docs.apiary.io/#"

Features

1. Users can be able to register and create an account
2. Registered users can be able to log in
3. Once logged in, the user can create a business. The business needs to be in a category so he/she can either choose a category that is created or create his/her own.
4. Each business created can has an ID and a unique business name
5. Logged in users can query all businesses or a single business by its ID
6. Only logged in users have the privilege of creating and viewing businesses
7. The logged in user can also view, update or delete the categories

Installation

1. Ensure you have installed Python3.6+, created and an activated a virtual environment.
2. Clone the repo in your local machine inside the virtual environment you have created.
3. Navigate to the project folder(WeConnect-API-oop-)
4. 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	User can be able to reset password
/api/v1/auth/logout	POST	Logs out User
/api/v1/category	POST	Create a business category
/api/v1/category	GET	Retrieve all created categories
/api/v1/category/<category_name>	PUT	Updates a business category
/api/v1/category/<category_name>	DELETE	Deletes a business category
/api/v1/<category_name>/business	POST	Create a business with unique ID and business name
/api/v1/<category_name/business	GET	Retrive all business created
/api/v1/business/<business_id>	PUT	Updates a business profile
/api/v1/business/<business_id>	GET	Retrive a business by ID
/api/v1/business/<business_id>	DELETE	Remove a business
/api/v1/business//reviews	POST	Add a review for a business
/api/v1/business//reviews	GET	Get all reviews for a business

UI Templates