Building, Installing and Setting up the Project

This guide outlines the steps for building, installing, and setting up the Timoni project.

Prerequisites

• Go 1.17 or later.
• Docker
• kubectl
• Git

Setting up a Development Environment

1. Clone the repository:

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

2. Install dependencies:

   make install-envtest
             

3. Build the project:

   make build
             

4. Run the tests:

   make test
             

5. Generate API documentation:

   make docs
             

Installation and Setup

1. Deploy Timoni to your Kubernetes cluster:

   Follow the instructions in the README to deploy Timoni to your Kubernetes cluster.

2. Configure Timoni:

   Refer to the Configuration documentation for configuring Timoni.

3. Start using Timoni:

   Once deployed and configured, you can start using Timoni. Refer to the User Guide for detailed instructions.

Running Timoni Locally

You can run Timoni locally for development and testing purposes.

1. Start the local development environment:

   make setup-envtest 
             

2. Run the Timoni server:

   make run
             

This will start a local Kubernetes cluster with Timoni deployed to it. You can access Timoni through the specified port in your local environment.

Contributing

To contribute to the project, please refer to the Contributing guidelines.

Additional Resources

• Timoni Documentation
• Timoni User Guide
• Timoni Configuration
• Timoni GitHub Repository