Live API available at: http://139.59.161.227:3211/choreflow/api/v1/swagger/ui
- Install Go v1.22.1+
Navigate to the project direcotory and run the following command:
go mod tidy
- Run/source/import the sql file at
db/chores_mgt.sql
on your sql database. - Update your environment variables to reflect your sql configuration.
List of environment variables to create:
DBAPIHOST
: MYSQL host (e.g. localhost).DBAPIPORT
: MYSQL port (e.g. 3306).DBAPIUSER
: MYSQL user that has access to the database.DBAPIPASS
: MYSQL user password.DBAPINAME
: Must bechores_mgt
.
Navigate to the project directory and run the command below:
go run .
Visit http://localhost:3211/choreflow/api/v1/swagger/ui to test the api.