WeConnect

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.

API

TL;DR Check the API docs at https://allconnect.herokuapp.com/api/v1

Set up the environment

This platform API is built on the top Flask python web framework.

Clone the repository

git clone git@github.com:muhozi/WeConnect.git

Create the virtual environment and install dependencies(These are required Python,pip and virtual environment):

cd WeConnect

virtualenv env

Activate the virtual environment [For windows]

cd env/Scripts && activate && cd ../..

Install dependencies using pip

pip install -r requirements.txt

Add required environment variables:

You may use .env configuration file (Loaded using python-dotenv):

Create file name it .env and add the following contents:

DEBUG=True
SECRET_KEY=any_chosen_secret_key

On windows(cmd):

SET SECRET_KEY=any_chosen_secret_key

SET DEBUG=True

On Unix based system:

export SECRET_KEY=any_chosen_secret_key

export DEBUG=True

Run the application

To run the tests, use nosetests or any other test runner of your choice

nosetests -v

Then run the app

python app.py

View API usage (Documentation)

View the API usage (Documentation) in a browser via: http://127.0.0.1:5000/api/v1

API Endpoints

POST /api/v1/auth/register User registration

POST /api/v1/auth/login User login

GET /api/v1/businesses/<business-id>/reviews Get all the reviews about a business

GET /api/v1/businesses/<business-id> Get a business details

Protected endpoints: Access token is required (Authorization header token)

POST /api/v1/auth/logout User logout

POST /api/v1/auth/reset-password Change password

POST /api/v1/businesses Register business

PUT /api/v1/businesses/<business-id> Update business details

DELETE /api/v1/businesses/<business-id> Delete business

GET /api/v1/businesses Get your registered businesses

POST /api/v1/businesses/<business-id>/reviews Post a review about business

The above endpoints may be accessed on Heroku, the base URL is https://allconnect.herokuapp.com

Also you may read and try out the detailed usage of the API through its documentation at

https://allconnect.herokuapp.com/api/v1

User Interface

WeConnect use the following UI technology:

CSS, HTML, JS
Bootstrap 4 (HTML, CSS, and JS Framework to develop UI)
Font icons : Ionicons

Have a look at the UI follow the link for a demo Demo

Author

Emery Muhozi

License

MIT License