WEconnectApplication

About 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.

To view pivotal tracker roadmap check out this link => https://www.pivotaltracker.com/n/projects/2153557

To View Weconnect source code switch to the gh-pages branch

To View Web Application check it out at https://weconnect-api.herokuapp.com/

Contents

• View live Template
• User Stories
• Technologies Used
• How to Install on local machine
• API Endpoints
• Hosted API Endpoints on Heroku
• Swagger API documentation on Heroku

View live Template

View the templates on github pages through this link

User Stories

• Users can register on the application
• Users can login to the application
• Users can register a business
• Users can update and delete businesses they registered
• Users can view a business
• Users can view all businesses
• Users can view businesses by their category or location
• Users can add reviews to a business
• Users can view all reviews for a business

Technologies Used

• HTML
• CSS
• Materialize CSS
• Express
• NodeJS
• Postgresql
• Heroku

Getting Started

Get the app running locally in the following way:

## Fork/Clone the Repo
change directory to the git repository by doing cd WEconnectApp

## Install dependencies
npm install

## Setup Database Client
Download POSTGRESQL database client
Create a database

## Setting up environmental variables
Create a .env file in the root directory of the repo
Add the following environmental variables:
DB_USERNAME =  Your local database username
DB_PASSWORD = Your database password
DB_DATABASE_TEST = Name of the database you want to use for the tests
DB_DATABASE_DEV = Name of the database you want to use for development
JWT_KEY = Your JSON web token secret key 

## Populate local database with necessary tables and columns
In your command line type npm run db-migrate and hit enter

## Run tests
npm test

## Run the application
npm start

## Use the application
Download Postman to interact with the endpoints below

The server would be live at http://localhost:8080, Swagger API documentation at http://localhost:8080/api-docs/

API Endpoints

HTTP REQUEST VERB	API ENDPOINT/PATH	ACTION
POST	/api/v1/auth/signUp	Register a user
POST	/api/v1/auth/login	Login user
PUT	/api/v1/auth/updateProfile	Update user profile details
POST	/api/v1/businesses	Register a business
PUT	/api/v1/businesses/:businessId	Update a business profile with the specified id
DELETE	/api/v1/businesses/:businessId	Delete a business with the specified id
GET	/api/v1/businesses/:businessId	Get a business with the specified id
GET	/api/v1/businesses/user	Get all businesses registered by a user
GET	/api/v1/businesses	Get all businesses
POST	/api/v1/businesses/:businessId/reviews	Add a review to a business
POST	/api/v1/businesses/:businessId/reviews/:reviewId	Add a reply to a review
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/businesses?category=category&location=location	Get businesses with a category and location

Hosted Endpoints on Heroku

View hosted endpoints on Heroku through this link

API documentation on Heroku

View swagger API documentation on Heroku through this link

                            ## Design Inspired by Pelumi longe