CamelHR API

This is the api service of camelhr application built with golang.

It provides ReST apis for managing the hrms data.

Local Development Setup

Prerequisites

• Go version 1.22 or above
• Docker Desktop

Start the application using docker

This application is configured to run with docker compose. Follow the steps below to start, restart or stop the application.

• Start or restart the application

  make up

  This will automatically build the project from source code and start the application & database containers in docker. If you make any changes to the code you can just rerun this command so that it will rebuild the project and update the respective container.

• Shutdown application using

  make down

• Shutdown application and clear database

  make nuke

Run tests & linters

• Run tests

  make test

• Run lint

  make lint

Database migrations

• Create a new schema migration file

  make migrate-create-schema name=<FILENAME>

• Create a new datafix migration file

  make migrate-create-datafix name=<FILENAME>

• Run up migration

  make migrate-up

• Run down migration

  make migrate-down

Contribution Guidelines

Every Contribution Makes a Difference

Read the Contribution Guidelines before you contribute.