nurd-commerce-core

nurd-commerce-core

Setting up the environment

Prerequisites

• Install golang
• Install docker
• VSCode Extensions:
  • Go
  • Docker
  • sqlfluff

Project setup

• Checkout the project locally

  git clone https://github.com/nurdsoft/nurd-commerce-core
  

• Change the directory to the project folder

  cd nurd-commerce-core
  

• To install the necessary libraries & tools run the below command

  make setup
  # this will take some time. Grab a coffee ☕️
  

Application Configuration

The application configuration is in the file ./config.yaml. Please change the values appropriately based on the environment.

Environment Variables

You can override the configuration values by setting them as environment values. Below are the environment variables that can override the config.yaml values.

Copy these values in a .env file.

cp .env.sample .env

[!TIP] Ask a team member for the values of the environment variables.

After adding the correct values, use make env to export the environment variables (only for MacOS and Linux).

Running the application

Local Env

Start Environment

• To start the services that are required for the application (e.g. database) run the below command

  make start-env
  

Build application

• Build the application using the below command

  make nurd-commerce
  

Running application

• Run the application locally using the below command

  make run-dev
  

  Access the application on http://localhost:8080 and you should see the OK JSON response from the application. Access the Swagger API docs on http://127.0.0.1:8080/docs/swagger/

Running the application in the docker container

• Run the application in the docker container using the below command

  make start-app
  

Stop Environment

• To stop all the services run the below command

  make stop-env
  

Kick-start running the whole application

• To run all the services including the application run the below commands

  git clone https://github.com/nurdsoft/nurd-commerce-core
  cd nurd-commerce-core
  make start-all
  

Database migrations

We use sql-migrate for database migrations

• To create a new migration

  make name=migration_script_file_name new-migration
  

• To apply outstanding migrations

  make migrate
  

• To roll back the last migration

  make migrate direction=down
  

Generating Mocks for Unit Testing

We use mockgen to generate mocks for unit testing. To generate mocks, run the below command

mockgen -source=internal/... -destination=internal/mocks/mock.go -package=package_name

[!TIP] Keep the mocks updated by running make mocks.

Integration Tests

This project includes integration tests that use a real PostgreSQL database to test database operations and queries.

Running Integration Tests Locally

make test-integration

Database Configuration

The integration tests use a separate test database with the following configuration:

• Host: localhost
• Port: 5453 (separate from the main app database on 5452)
• Database: commerce-core
• User: db
• Password: 123

This ensures that integration tests don't interfere with your local development database.