vending-machine-control-system

README

vending-machine-control-system

Go Microservice Template

This is the code repository for Vending Machine System Control, simple API to handle vending machines.

Build, test, and deploy robust golang microservices

• About the project
• Reference
• Getting started
  • Prerequisites
  • Setup
• Testing
  • Linting
  • Building
  • Cleaning
  • Continuous Integration
• Notes

About the project

The repo is used to handle vending machine as a central systems.

Reference

• Deployment Instructions
• API Docs
• Design Decisions and Technical Considerations
• Environment Variables

Getting started

Prerequisites

• Go 1.13+

Setup

1. Clone the repository and navigate to the root directory of the project:

git clone https://github.com/samannsr/vending-machine-control-system.git
cd vending-machine-control-system

1. Create a .env file in the env directory of the project and copy the local.env environment variables.

You can run the following command to build and start the containers:

docker-compose up -d --build

OR

1. Install the dependencies:

make dep

1. Run the development server:

make run_dev

This will start the http server on port 8080. You can customize the ports by setting the HTTP_PORT environment variable.

Testing

To run the tests, use the following command:

make test

To generate a test coverage report, use the following command:

make test_coverage

Linting

To lint the code, use the following command:

make lint

This will run all available linters, including Go lint, Dockerfile lint, and YAML lint.

Building

To build the binary, use the following command:

make build

This will create a binary in the out/bin directory. You can run the binary with the following command:

make run

Cleaning

To clean the build artifacts and generated files, use the following command:

make clean

This will remove the bin and out directories, as well as any build-related files.

Notes