Codebase

Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.

Getting Started Commands

make build: Compile the source code and generate the binary

make install: Install the generated binary and its dependencies

./<binary_name>: Run the binary

make start: Start the application with any necessary dependencies

make test: Run all tests for the project

make test <test_file>: Run a specific test file

make deploy: Build and deploy the application to the production environment

make release: Create a new release tag and push the code to the remote repository

make clean: Remove generated files and restore the project to its original state

make help: Display available commands and their descriptions

make lint: Check the codebase for style and syntax errors

make coverage: Generate code coverage reports for the tests

Below is a short description of the key directories of the project to aid you when understanding where key files are located.

autoflow/ - This directory contains the source code for Autoflow.

bin/ - Contains the compiled binary of Autoflow.

conf/ - Contains the configuration files for Autoflow.

controllers/ - Contains the API controllers for handling requests.

docs/ - Contains the documentation for Autoflow.

go.mod - The Go module file for managing dependencies.

go.sum - The Go checksum file for verifying the integrity of downloaded packages.

LICENSE - The license for the project.

models/ - Contains the Go models for the data structures used in Autoflow.

plugins/ - Contains the plugins for extending the functionality of Autoflow.

README.md - The main documentation file for the project.

utils/ - Contains the utility functions used in Autoflow.