This is the code repository for Vending Machine System Control, simple API to handle vending machines.
Build, test, and deploy robust golang microservices
The repo is used to handle vending machine as a central systems.
- Deployment Instructions
- API Docs
- Design Decisions and Technical Considerations
- Environment Variables
- 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
- Create a .env file in the
env
directory of the project and copy thelocal.env
environment variables.
You can run the following command to build and start the containers:
docker-compose up -d --build
OR
- Install the dependencies:
make dep
- 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.
To run the tests, use the following command:
make test
To generate a test coverage report, use the following command:
make test_coverage
To lint the code, use the following command:
make lint
This will run all available linters, including Go lint, Dockerfile lint, and YAML lint.
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
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.