Bonifaceebuka / talosmart-nodejs-assessment

Talosmart-nodejs-assessment

This is an assessment I did for the role of a NodeJS developer for Talosmart

Software Engineer Assessment

This application is built with the following technologies:

1. NodeJS(v16.13.2)
2. MYSQL(8.0)
3. NPM version 8.1.2

This is how you can install this application

1. Clone this Repository(Repo) with the following command git clone https://github.com/Bonifaceebuka/talosmart-nodejs-assessment.git
2. Move to the DIR of the Repo cd talosmart-nodejs-assessment
3. Install the necessary NPM packages with npm install
4. Save .env.example file as .env or run this command: cp .env.example .env or rename .env.example file to .env
5. Open the .env file and set the Database configurations as follows:
   DB_CONNECTION_DIALECT=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   APP_KEY=ANY_RANDOM_VALUE
   DB_DATABASE=YOUR_DATABASE_NAME
   DB_USERNAME=YOUR_SERVER_USERNAME
   DB_PASSWORD=YOUR_DATABASE_PASSWORD (Leave it empty if you have none)
   PORT=YOUR_PREFERRED_PORT_NUMBER
   
6. Import the database tables using talosmart-nodejs-assessment.sql file in /src/db folder of this project
7. Start your server with npm run dev

About the API documentation

The complete API documentation for this project is published on Postman. You can access it using this link https://documenter.getpostman.com/view/16611684/2s9YeN2oQm