Giter Club home page Giter Club logo

jobber's Introduction

Jobber Build Status

Preparations(if you haven't already)

  1. install node.js https://nodejs.org and click the Install button
  2. install mongoDB http://mongodb.org and click Download MongoDB.
  3. install Nodemon
npm install nodemon -g
  1. clone the project
git clone https://github.com/aelittaezugbaya/Jobber.git
  1. go to the project folder
  2. run npm install or npm i

How to start the app

How to use:

npm run [script name]

We have several npm scripts:

  • start: launches front-end in development mode, it will watch for changes in folder frontend and refresh the page
  • backend-dev: launches back-end in development mode, it will watch for changes in backend code and relaunch server
  • backend: launches back-end
  • build: builds front-end and outputs results to folder public

Note: Folder public is not included in repository, you have to run npm run build to get it.

Default ports

Front-end

If you run npm start then front-end will run on http://localhost:8080

Back-end

If you run npm run backend or npm run backend-dev then back-end will run on http://localhost:3000. Built front-end from folder public also is hosted on this port.

###Proxy If you run npm start and npm run backend/npm run backend-dev then requests to http://localhost:8080/api will redirected to http://localhost:3000/api.

API Reference

Authentication (JWT Not Required)

POST /api/auth/login

  • Email
  • Password

POST /api/auth/register

  • FullName
  • Email
  • DateOfBirth
  • Gender
  • Password
  • Lat
  • Lon

Feedback Object

GET /api/feedback/:ReceiverId

  • UserSourceID
  • UserReceiverID
  • Comment
  • Rating

POST /api/feedback

  • UserSourceID
  • UserReceiverID
  • Comment
  • Rating

Service Object

GET /api/service/:id

  • UserOwnerID
  • IsRequest
  • Subject
  • Category
  • Location
    • type
      • type
    • coordinates
      • Lon
      • Lat
  • Gender
  • Description
  • Price
  • Status
  • DateCreated

GET /api/service/:lat/:lon/:radius

  • all service objects within the radius

POST /api/service

  • UserOwnerID
  • IsRequest
  • Subject
  • Category
  • Lon
  • Lat
  • Gender
  • Description
  • Price

PUT /api/service/:id

  • UserOwnerID
  • IsRequest
  • Subject
  • Category
  • Lon
  • Lat
  • Gender
  • Description
  • Price

User Object

GET /api/user/:id

  • Rating
  • FullName
  • Email
  • Description (User description defaults to 'Hello, I am .' upon registration)
  • Hash
  • Salt
  • DateOfBirth
  • Gender
  • Status

PUT /api/user/:id

  • FullName
  • DateOfBirth
  • Gender
  • Description

jobber's People

Contributors

aelittaezugbaya avatar andreaskuepfer avatar anton5 avatar hannuju avatar ramon54321 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

jobber's Issues

Travis Authentication

Travis requires environment variables. Most likely need to use travis CLI. @aelittaezugbaya I think you might have to do it since it requires admin rights most likely.

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.