This project contains the backend code for the EngageXr coding assigment.

• Used Typescript in the project
• Implemented Typescript Sequelize
• Basic JWT Authentication: ability to log in as administrator
• Used Node, Express, Sequelize, Sequelize-Typescript, JWT, ESlint, Prettier, Winston Logger, express-validator
• Created Express routing to demonstrate CRUD functionality (Create / Read / Update / Delete) for two API items: Companies and Employees
• Used Express validation middleware to demonstrate basic payload validation
• Used Express middleware to enforce authorisation
• Companies DB table consists of these fields: Name (required), email, phone, website
• Employees DB table consists of these fields: First name (required), last name (required), Company (foreign key to Companies), email, phone
• User DB table (Additional table to enforce log in as admin functionality)

• This project is built with MySQL as database choice. Please setup MySQL in the system before installing and running the project.
• After installing MySQL in the system, create a database inside.
• Once you setup your mysql database you need to set the database name, username, password in src/configs/sequelizeconfig.ts file

• All the API reference is given in the API Reference docs. However, to ease API testing there is a POSTMAN api JSON file added in the root of the project (/postman/engagexr-apis.postman_collection.json) directory. Import this file in the POSTMAN application and test the API with pre-loaded data. More info about API's is given in the API Reference section.

• you can find the server logs under logs folder under the root directory.

To run this project, you will need to add the following environment variables to your .env file

SECRET=35c452171f3505f6516011ed1945212

Clone the project

  git clone https://github.com/saurabhk06/engagexr.git

Go to the project directory

  cd engagexr

Install dependencies

  npm install

Run the server locally in development

  npm run dev

  npm run build

Run the server after running the build.

  npm start

Server: Node, Express, Sequelize, JWT, Eslint, prettier, Winston

  POST http://localhost:4000/api/signup

  POST http://localhost:4000/api/signin

All the company API requires Authorisation header containing Bearer Token and Content-Type header

• use the Signin API shown above to generate the token.

  Headers	Type	value
  Content-Type	string	application/json.
  Authorization	string	Bearer [YOUR_TOKEN].

  POST http://localhost:4000/api/create-company

  GET http://localhost:4000/api/companies

  GET http://localhost:4000/api/company/:companyId

  PATCH http://localhost:4000/api/company/:companyId

  DELETE http://localhost:4000/api/company/:companyId

All the employee API requires Authorisation header containing Bearer Token and Content-Type header

• use the Signin API shown above to generate the token.

  Headers	Type	value
  Content-Type	string	application/json.
  Authorization	string	Bearer [YOUR_TOKEN].

  POST http://localhost:4000/api/create-employee

  GET http://localhost:4000/api/employees

  GET http://localhost:4000/api/employee/:employeeId

  GET http://localhost:4000/api/company/:companyId/employees

  PATCH http://localhost:4000/api/employee/:employeeId

  DELETE http://localhost:4000/api/employee/:employeeId

• Saurabh Kumar (DamcoGroup)