HR - Management Sample API using AdonisJS

HR-Management is a backend project for Technical Test Back End with Adonisjs.

Getting Started

Prerequisite

Make sure you have installed all of the following prerequisites on your development machine:

1. Node.js - Download and Install Node and the npm package manager.
2. Yarn - Download and Install Yarn

Installing

1. Make sure you got the Prerequisites Installed on your local computer.
2. Download file .zip or clone via github https://github.com/vinsapr/management
3. Open terminal in your project directory and execute this yarn command in the current directory

   yarn
   

4. Crate file .env then copy the value from file .env.example
5. After the installation complete, execute this command below to start the project in your local machine

   yarn dev
   

6. HR-Management is running on port PORT value where you set the .env file. Example:

   PORT=3333
   

   Then the project will running on port 3333
7. Done.

DB Migration

1. Make sure you already connect with mysql and have database with name management
2. Execute this command below to run the migration

    yarn run-migration
   

3. If you want to running the seeder to make dummy data, execute this command:

   yarn run-seed
   

Swagger

1. Make sure you already running the project include database migration
2. open the server address that shown in the terminal when running by adding /docs in the browser

   Server address: http://127.0.0.1:3333/docs
   

3. Select Auth Register or login to get bearer token
4. Copay the token and klik Authorize then copy the token into the input field by adding bearer in front of the token

   bearer NjI.cRQFr4VxXmDxrxO2K5vpK3naA0V2qj8qlM4vrc6o7bgm3dtu9trE_SSJoRvb
   

5. Now you can access data employee

Built With

• Node - Javascript Runtime Environtment
• Yarn - Package Manager
• AdonisJS - Nodejs framework
• MySQL