Start & Build stefanprodan/timoni Codebase

Building and Starting the Timoni Project

This guide will walk you through the steps required to build and start the Timoni project.

Prerequisites

• Go: Ensure you have Go installed and configured.
• Docker: Docker is required for building the project and running the environment test.
• Make: Make is used to automate the build process.

Building the Project

1. Clone the Repository:

   git clone https://github.com/stefanprodan/timoni.git
   cd timoni
   

2. Build the Project:

   make build
   

   This command will compile the project using the go build command and create an executable file named timoni in the bin directory. The github.com/stefanprodan/timoni Golang module name influences the output of the go build command. [Source: Makefile]

Starting the Project

The timoni executable can be run directly from the bin directory:

./bin/timoni

Running the Environment Test

The project includes an environment test that allows you to test Timoni in a controlled environment.

1. Setup the environment test:

   make setup-envtest
   

2. Start the environment test:

   make envtest
   

3. Stop the environment test:

   make install-envtest
   

Generating Documentation

1. Prepare documentation:

   make prep-docs
   

2. Generate documentation:

   make docs
   

Other Useful Commands

• Run Tests: make test
• Format Code: make fmt
• Run Static Code Analysis: make vet
• Install Dependencies: make install
• Push Redis image: make push-redis
• Clean Up: make tidy
• Generate Code: make generate

Docker

The Dockerfile for the project exposes port null in production. [Source: Dockerfile]