Thank you for your interest in contributing to AkôFlow! This guide will help you set up your development environment and start contributing to the project.

Getting Started with Development

AkôFlow uses Dev Containers to provide a consistent development environment for all contributors. This approach eliminates “it works on my machine” problems and ensures everyone has the same dependencies and tools.

Prerequisites

Before you begin, make sure you have the following installed:

1. Docker: Required to run the development container
   • Install Docker
2. Visual Studio Code: Recommended IDE with Dev Containers support
   • Install VS Code
   • Install Dev Containers extension
3. Git: For cloning and working with the repository
   • Install Git

Setting Up Your Development Environment

1. Clone the repository git clone https://github.com/UFFeScience/akoflow.git cd akoflow
2. Open in VS Code with Dev Container
   • Open VS Code
   • Open the cloned repository folder
   • VS Code should detect the Dev Container configuration and prompt you to reopen in container
   • Alternatively, click the green button in the bottom-left corner and select “Reopen in Container”
3. That’s it!
   • The container will automatically build with all the necessary dependencies
   • The Go environment, including required tools like gopls and delve, is pre-configured
   • The container includes all dependencies like gcc, libc-dev, sqlite, git, curl, and graphviz

Getting Help

If you encounter any issues or have questions, feel free to open an issue on GitHub or reach out to the maintainers:

• Wesley Ferreira – @ovvesley
• Daniel de Oliveira – @danielcmo

Also we have a discord community, click here to join with us.