WeConnect

WeConnect provides a platform that brings businesses and individuals (customers) together.

• Application link

---

Table of contents

• Introduction
• Getting Started
• Prerequisites
• Installation
• Tests
• Built With
• Authors
• License

---

Introduction

The application currently has the following features working:

• sign up
• login
• reset password
• register business
• update business
• retrieve a business
• retrieve all businesses
• retrieve business by location
• retrieve business by category
• delete business
• review a business
• retrieve all reviews for a business

This project is divided into three parts:

1. The Templates:

   • This part holds the UI / template for the project.

2. The Server:

   • This part holds the server-side functionalities.

3. The Client:

   • This part hold the front-end functionalities which users get to intereact with.

Getting Started

• The template folder holds the project UI templates, hosted on github pages.

  • To view the UI template for the WeConnect web application, please click this link WeConnect UI

• The server folder holds the backend API, hosted on heroku.

  • To view the API docs with dummy data, please click this link WeConnect API docs (dummy data)
  • To view the API docs with database data, please click this link WeConnect API docs (database data)

• The client folder holds the React App, hosted on heroku.

  • To view the app, please click this link WeConnect React

Prerequisites

• To view the UI Template and API docs, please use a web browser, preferably, Google Chrome.
• To run the app, you need to have NODE JS installed
• You need to have POSTGRES database

Installation

• Navigate to a directory on your machine using your favourite terminal / command line application
• Clone this repository into that directory
  • Using SSH: git clone [email protected]:saheedt/WeConnect.git
  • Using HTTP: git clone https://github.com/saheedt/WeConnect.git
• Navigate to the repository's directory
  • cd WeConnect
• Install the app's dependencies
  • npm install
• Run application
  • npm run postinstall
  • npm start

Tests

• The tests were written using SuperTest and chai
• The test coverage is generated by istanbul
• To run tests, navigate to the project's root directory
• After installation, run the following command
  • npm run test
  • npm run client:test

Built With

• HTML/CSS
• Javascript
• Materialize Css
• Express Js
• Node js
• React Js

Authors

• Saheed Ajibulu

License

This project is licensed under the MIT License - see the LICENSE.md