aisoc-api

README

AISoC credits API:

Compilation:

Compile Time Dependencies:

1. go 1.18
2. make

Runtime Dependencies:

1. sqlite

Steps:

$ make

Running:

1. Copy .env-example provided in the project root and create a corresponding .env file.
2. Fill .env with the required fields.
3. Compile the application and run the binary.

Contributing:

1. Fork this repository.
2. Make all your changes against the main branch in a patch branch.
3. Run make check to make sure all tests and linting checks pass.
4. Follow standard golang practices to reduce heap allocations! This is done to ensure that the compiler can inline most of our code for good performance.
5. Run make allocs to make sure no new allocations are made on the heap that are unecessary.
6. All commit messages should adhere to conventional commits.