We-connect#

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 and even new ones.

Documentation

Find API documentation here: WE-connect documentation

WEConnect App UI Template

• The gh-pages branch contains the template UI for the WEConnect app
• click here for UI demo

App Status

Not ready for release yet, still in development mode

Getting Started

Before installing, download and install Node.js.
Installation is done using the npm install command:

Install

npm install 

Features

• Users can view businesses
• Users can post a business
• Users can review a business
• Users can delete a business
• Users can search for a business
• Users can search for a business by category
• Users can search for a business by location

Run App(dummy-data)

npm run start:dev

Run Test

npm run test

API endpoints and functions

Type of request	route(endpoint)	Description
POST	api/v1/auth/signup	create a new user
POST	api/v1/auth/login	login existing user
POST	/api/v1/businesses	create a new business
GET	/api/v1/businesses	get all businesses
DELETE	/api/v1/businesses/:businessId	delete a particular business
GET	/api/v1/businesses/:businessId	to retrieve a particular business using its businessId
PUT	/api/v1/business/:businessId	to update a particular business using its businessId
POST	/api/v1/business/:businessId/reviews	to post a review for a given business using its businessId
GET	/api/v1/business/:businessId/reviews	to get reviews of a particular business using its businessId
GET	/api/v1/businesses?location=keyword	get businesses based on key word (serach query)
GET	/api/v1/businesses?category=keyword	get businesses based on key word (serach query).