zenas

module

v0.0.0-...-fd03070 Latest Latest Go to latest Published: Mar 15, 2024 License: GPL-3.0

Details

This section will guide you through getting @1sl4nds/zenas up and running on your local development environment.

Before you begin, ensure you have the following installed:

Docker: For containerization and easy deployment of the application and its dependencies.
Go: Required to build the application from the source.
Python: Used for certain scripts and data processing tasks.
Terraform: For provisioning and managing the infrastructure as code.

Follow these steps to get your development environment set up:

1. Clone the repository to your local machine:

git clone https://github.com/1sl4nds/zenas.git
cd zenas

2. Build the Docker images:

docker-compose build

3. Initialize the infrastructure with Terraform (ensure you're in the depoy/terraform directory):

terraform -chdir ./deploy/terraform init
terraform -chdir ./deploy/terraform apply

4. Start services using Docker Compose:

docker-compose up -d

This will start all the required services as defined in the docker-compose.yml file.

After successfully installing the application, you can start using it by:

Accessing the OpenAPI documentation for the API at http://localhost:8080/api-docs to understand how to interact with the API.
Exploring the Grafana dashboards at http://localhost:3000 for monitoring and analytics.
Checking the logs and metrics collected by Prometheus and Jaeger for performance and tracing.

We welcome contributions to @1sl4nds/zenas! Please read CONTRIBUTING.md for more information on how to get started with contributing.