Business Server

Getting Started

Prerequisites

What you need to install

node.js

Docker image repository

https://hub.docker.com/r/khalil71/business

Installing dependencies

$ npm i

To run the server

$ npm run start

Testing

To run all tests

$ npm run test

To run companies tests

$ npm run test-comp

To run workspaces tests

$ npm run test-work

To run users tests

$ npm run test-user

APIs

Server runs on http://localhost:3000/

Companies APIs

Get all companies

GET /

Get one company

params: (displayName: required)

GET /:displayName

Add company

body: (displayName: required)

POST /

Update company

params: (displayName: required) --- body: (newDisplayName: required)

PATCH /:displayName

Workspaces APIs

Add workspace

params: (companyDisplayName: required) --- body: (workspaceDispalyName: required)

POST /:companyDisplayName/workspaces

Update workspace

params: (companyDisplayName: required, workspaceDispalyName: required) --- body: (newWorkspaceDispalyName: required)

PATCH /:companyDisplayName/workspaces/:workspaceDispalyName

Users APIs

Add user

params: (companyDisplayName: required, workspaceDispalyName: required) --- body: (email: required, role: required)

POST /:companyDisplayName/workspaces/:workspaceDispalyName/users

Update user

params: (companyDisplayName: required, workspaceDispalyName: required) --- body: (email: required, newRole: required, newEmail: required) [newRole or newEmail or both]

PATCH /:companyDisplayName/workspaces/:workspaceDispalyName/users

Remove user

params: (companyDisplayName: required, workspaceDispalyName: required) --- body: (email: required)

DELETE /:companyDisplayName/workspaces/:workspaceDispalyName/users

Author

• Mohamed Hegab - Github link - Khalil71