Employee Study Case

This is my answer for creating employee api.

Run Locally

Clone the project

  git clone https://github.com/fwidyatama/employee

Go to the project directory

  cd employee

Setup

This project already included with docker-compose file. But before you run the compose file make sure you already change the host in .env file.

  DB_HOST=postgres-db

But beside that, you can change .env with your desired value.

DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=employees
DB_PORT=5432
DB_HOST=postgres-db

Start the server

Before running the command, make sure you already install docker on you computer.

You can refer to this link for detail about the installation : Docker Installation

You can run the server through this command :

make build

After you run the command above, all container will run in your local computer, included :

• Employee API
• PostgresSQL

After that you can access all endpoint via http://localhost:{*your_port*}

Endpoints

All endpoints available in postman collection file. You can see docs folder. For open the file, you can use postman.
To open the collection file, you can follow this step :

1. open postman
2. open menu file
3. choose the collection file in docs folder
4. run the server and you can try the endpoint via postman.

Test

To run unit testing, you can run it via this command :

make test