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.
- Application Features
- Prerequisites
- Getting Started
- API Documentation
- Running the tests
- Built With
- Contributing to the Project
- FAQ
- Application Limitations
- License
- Credits
- Users can register on WEconnect
- Users can log into WEconnect
- Users can view all businesses
- Users can search for any business
- Users can search businesses by category
- Users can search businesses by location
- Users can search businesses by location and category
- Users can write a review for any business in the catalog
- Users can register businesses in WEconnect
- Users can update their businesses
- Users can delete their businesses
| HTTP VERB | ENDPOINT | FUNCTIONALITY | |
|---|---|---|---|
| POST | api/v1/businesses | Add Business to catalog | |
| PUT | api/v1/businesses/:businessId | Update business | |
| DELETE | api/v1/businesses/:businessId | Delete business | |
| POST | api/v1/businesses/:businessId/review | Add review for a business | |
| GET | api/v1/businesses/:businessId/review | Get all reviews for a business | |
| GET | api/v1/businesses | Get all businesses | |
| GET | api/v1/businesses/:businessId | Get details of a business | |
| GET | api/v1/businesses?location=location | Get businesses in a particular location | |
| GET | api/v1/businesses?category=category | Get businesses in a particular category | |
| GET | api/v1/businesses?location=location&category=category | Get businesses by location and category | |
| POST | api/v1/auth/signup | Create a user | |
| POST | api/v1/auth/login | Sign in a user |
- Install NodeJs and Postgresql locally
- The app returns data in JSON format and require a client device that can parse JSON.
Follow the steps below to get the app running locally:
# Clone the repository
>$ git clone https://github.com/danoseun/WeConnect.git
# Change directory into it
>$ cd Weconnect/newConnect
# Install all dependencies
> npm install
# Create a .env file and fill it with the sample provided in .env.sample file
> $ touch .env
# Start the application in development mode
> $ npm run migrate
> $ npm run start:dev
# Open running application on browser
> http:localhost:3000/
Access API documentation through this link Here
UI Template: https://danoseun.github.io/WEconnect/template/index.html
- Run the test with the command
> $ npm run test
Bootstrap
Node.js
Express
postgreSQL
Sequelize ORM
Contributions are welcome and appreciated. To contribute
- Fork this repository or clone the repository with the command
$ git clone https://github.com/danoseun/WeConnect.git - Change directory into the folder with the command
cd WeConnect/newConnect - Create your feature branch and make your contributions to your local copy of the project
- Raise a pull Request against the development branch describing what your feature does and how it can be tested
Yes it is, and contributing to the development of this
application is acceptable and by raising a pull request
Anyone!. This application is open to all those who want to contribute to open-source development and are willing to follow the set standards for contributing.
//#### What language was used to develop this application? // This project is a full stack Javascript application
Yes!. This application is licensed under MIT. Further information can be found in the LICENSE file.
The API response is in JSON format
- The application runs on a single database and might impact the speed of response
- Users cannot register or login with their social accounts at the moment
Oluwaseun Somefun