Skip to content

Rwothoromo/WeConnect-React

Repository files navigation

WeConnect

Build Status Coverage Status Maintainability Test Coverage

WeConnect brings businesses and users together, and allows users to review businesses.

Features

  1. Users can create an account and log in
  2. Authenticated Users can register a business.
  3. Only the user that creates the business can update and delete a business
  4. Users can view businesses.
  5. Users can give reviews about a business.
  6. Users can search for businesses based on business location or business category.

View on Heroku

Documentation

Component documentation for this project generated by running npm run doc.

Setup

  • Run git clone this repository and cd into the project root.
  • Run npm install on command prompt
  • Run export REACT_APP_BACKEND_HOST=https://weconnect-api-v2-rwothoromo.herokuapp.com/api/v2 on command prompt
  • Run npm start on command prompt
  • View the app on http://localhost:3000

Tests

  • Run npm run test on command prompt
  • Run npm run coverage on command prompt to generate coverage reports

Builds

  • Run npm run build on command prompt
  • Run npm install -g serve to serve the app on a static server
  • Run serve -s build and view the app on http://localhost:5000

API

Visit WeConnect-App