Code Monkey home page Code Monkey logo

weconnect's Introduction

WEconnect

Build Status Coverage Status Maintainability Test Coverage

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.

The Template pages of WEconnect app can be accessed here .

The app server endpoints are hosted on heroku.

Made With

Template

* Bootstrap 4 for UI styling
* CSS for custom styling
* Html for the web pages
* Javascript to add some behaviour

Server

* Nodejs for server-side logic
* Express for api routes implementation
* Heroku for hosting services

Continuous Integration

* Travis CI & Codeclimate for test automation
* Coveralls for test coverage report
* Hounds CI for linting report according to Eslint

Test-Driven Development

* Mocha & Chai for api route testing

Installation.

  • Install Nodejs
  • Clone this repo git clone https://github.com/d-beloved/WEconnect.git
  • Run npm install to install the required dependencies
  • Run npm test to fireup the tests
  • Navigate to http://localhost:3001/

Available API Endpoints

HTTP REQUEST VERB API ENDPOINT/PATH ACTION
POST /api/v1/auth/signUp Register a user
POST /api/v1/auth/login Login user
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/userBiz 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
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

Check here for full documentation.

License and Copyright

© Ayodeji Moronkeji

Licensed under the MIT License. More details coming in soon...

weconnect's People

Contributors

d-beloved avatar

Watchers

 avatar  avatar

Forkers

mskinho

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.