DEELER BACKEND

Setup

Copy the .env-example and rename to .env
Run npm install to fetch dependencies
Run npm run seed to seed database and
run npm run start:dev to start the project
Go ham on those APIs, see endpoints below

*** see package.json for a list of other commands available when working with the project ***

Possible Improvements

Codebase could benefit from refactors and improvements such as:

Implement input validation to the apis
Better logging
Add styling/linting - code quality uniformity checks on commit
Containerize make ready for deployment
Add separate configs for dev, prod, staging
Add Admin type of profile and create middleware to only allow admins access admin routes
Tests and Coverage
in the balances/deposit/:userId route should probably remove the :userId param - already have it passed in header
Caching those queries
Migrations

Technical Notes

Where date is required while posting to api, the format will be yyyy-mm-dd

The server is running on port 3001 by default. You can change this in the .env file
To authenticate users use the getProfile middleware that is located under src/middleware/getProfile.js. users are authenticated by passing profile_id in the request header. after a user is authenticated his profile will be available under req.profile. make sure only users that are on the contract can access their contracts.

App Components

Laid out in respective directory by function. Important ones are

Models - src/models/
Controllers - src/controllers
Middleware - src/middleware

Profile

A profile can be either a client or a contractor. clients create contracts with contractors. contractor does jobs for clients and get paid. Each profile has a balance property.

Contract

A contract between and client and a contractor. Contracts have 3 statuses, new, in_progress, terminated. contracts are considered active only when in status in_progress Contracts group jobs within them.

Job

contractor get paid for jobs by clients under a certain contract.

APIs Implemented

Below is a list of the available API's for the application.

GET /contracts/:id - It should return the contract only if it belongs to the profile calling.
GET /contracts - Returns a list of contracts belonging to a user (client or contractor), the list should only contain non terminated contracts.
GET /jobs/unpaid - Get all unpaid jobs for a user (either a client or contractor), for active contracts only.
POST /jobs/:job_id/pay - Pay for a job, a client can only pay if his balance >= the amount to pay. The amount should be moved from the client's balance to the contractor balance.
POST /balances/deposit/:userId - Deposits money into the the the balance of a client, a client can't deposit more than 25% his total of jobs to pay. (at the deposit moment)
GET /admin/best-profession?start=<date>&end=<date> - Returns the profession that earned the most money (sum of jobs paid) for any contactor that worked in the query time range.
GET /admin/best-clients?start=<date>&end=<date>&limit=<integer> - returns the clients the paid the most for jobs in the query time period. limit query parameter should be applied, default limit is 2.

 [
    {
        "id": 1,
        "fullName": "Reece Moyer",
        "paid" : 100.3
    },
    {
        "id": 200,
        "fullName": "Debora Martin",
        "paid" : 99
    },
    {
        "id": 22,
        "fullName": "Debora Martin",
        "paid" : 21
    }
]

Example requests


### Get contract belonging to user
GET  http://localhost:3001/contracts/3
content-type: application/json
profile_id: 6

### Get all active contracts belonging to user
GET  http://localhost:3001/contracts
content-type: application/json
profile_id: 3

### Get all unpaid jobs for active contracts belonging to user
GET  http://localhost:3001/jobs/unpaid
content-type: application/json
profile_id: 2

### Client pay for a job
### Job 5 profile 4 has insufficient balance example ;; 1,1 for one which just works, might have to reseed db
POST  http://localhost:3001/jobs/1/pay
content-type: application/json
profile_id: 1

### Client deposit into his account
POST  http://localhost:3001/balances/deposit/2
content-type: application/json
profile_id: 2

{
    "amount": 39
}

### Get best profession within range
GET  http://localhost:3001/admin/best-profession?start=2018-10-10&end=2023-12-12
content-type: application/json
profile_id: 8

### Get all unpaid jobs for active contracts belonging to user
GET  http://localhost:3001/admin/best-clients?start=2019-10-10&end=2022-12-12&limit=2
content-type: application/json
profile_id: 5

evroza / devql2022