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.

Contents

• Features
• Technology Used
• View live Template
• View Hosted App
• View Hosted Endpoints
• View API documentation
• Getting Started
• API Endpoints

Features

• A user can register on the application
• A user can login to the application
• A user can register a business
• A user can update and delete businesses they registered
• A user can view a business
• A user can view all businesses
• A user can view businesses by their category or location
• A user can add reviews to a business
• A user can view all reviews for a business
• A user can transfer his/her business to another user

Technology Used

• HTML
• CSS
• Bootstrap4
• Express
• NodeJS
• postgreSQL
• Sequelize
• React and Redux
• Heroku

View live Template

View the templates here

View Hosted App

View the hosted app on heroku here

View Hosted Endpoints

View hosted endpoints on Heroku here

View API documentation

View swagger API documentation of endpoints on Heroku here

Getting Started

You can get the app running locally in the following way:

# Clone the Repo
git clone https://github.com/Orelongz/WeConnect.git

# Version
> Make sure you are running node 8.11.1 and npm 5.6.0 (you might want to use nvm)

# Install dependencies
> npm install
> Create `.env` file from the `.env.sample` file using the appropriate values

# Run tests
> Create the database needed as set in the .env file with the specified user having appropriate rights
> npm run test-migrate
> npm run test

# Run the application
> Create the database needed
> npm run dev-migrate
> npm run start:dev

The server and app would be live at http://localhost:8000, Swagger API documentation at http://localhost:8000/api-docs/ Endpoints live at http://localhost:8000/api/v1/

API Endpoints

Request	End Point	Action
POST	/api/v1/auth/signup	Register a user
POST	/api/v1/auth/signin	Login user
PUT	/api/v1/user	Edits the details of an user
GET	/api/v1/user	Retrieves the details of an user
POST	/api/v1/businesses	Register a business
PUT	/api/v1/businesses/:businessId	Update a business profile
DELETE	/api/v1/businesses/:businessId	Delete a business
GET	/api/v1/businesses/:businessId	Get a business
GET	/api/v1/businesses/	Get all businesses
GET	/api/v1/businesses/user	Get all user businesses
PUT	/api/v1/businesses/change-ownership/:businessId	Transfers business ownership to another user
POST	/api/v1/businesses/:businessId/reviews	Add a review to a business
GET	/api/v1/businesses/:businessId/reviews	Get all reviews for a business
GET	/api/v1/businesses?location=location	Get businesses with a location
GET	/api/v1/businesses?category=category	Get businesses with a category
GET	/api/v1/categories	Retrieves a list of available categories
POST	/api/v1/businesses/:businessId/reviews	Add a review to a buisness
GET	/api/v1/businesses/:businessId/reviews	Retrieve all reviews for a business
GET	/api/v1/reviews/:reviewId	Retrieve a review
PUT	/api/v1/reviews/:reviewId	Edit a review
DELETE	/api/v1/reviews/:reviewId	Delete a review