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. It has the following features:
- User Signup
- Filter businesses by location, category or name
- View businesses
- View reviews
- User Signin
- Add business
- Update business
- Delete business
- Review and rate a business
- Edit a review
- Delete a review
- NodeJs
- Express
- Sequelize
- Postgresql
- React
- Redux
Getting this project up and running on your local machine is pretty easy. Follow the steps below to complete the setup
-
Install global packages: Skip this step if you have NodeJS and postgresql installed. For those who don't, you can head to Node.js and Postgresql to download.
-
Additional setup: This app uses the dotenv npm package to load environment variables. For more info visit dotenv. Rename .env_example file to .env, open the .env file and rename your username and password according to your postgresql setup, you can also rename your jwt secret. Run on your terminal/cmd
open pgAdmin and create two databases. weconnect-api(for app development) and weconnect_test(for running tests) -
Clone this repo: Open cmd(command prompt) for windows users, terminal for linux and mac users.
git clone https://github.com/Nedson202/WeConnect.git -
Install project dependencies: Enter the following in your terminal/cmd to change into the directory of the cloned repo and install all app dependencies
change directory to cloned repo (WeConnect) npm i -
Start the app: Enter the following on your terminal/cmd to start the app
npm run start-dev -
Open browser
Run http://localhost:4000 on the address bar
You can use the following to run tests:
- Backend:
npm run test - Frontend:
npm run test:client
Click here to view the api documentation
- Airbnb style guide
Click here to view dependencies
- Javascript
NEGEDU SAMSON
MIT © Negedu Samson
Licensed under the MIT LICENSE