- If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.
- If you don't see your idea listed, Please raise an issue or open a pull request.
- If you wish to work on an issue reported by other users, Please claim it by commenting on the Github So we can avoid multiple contributors from working on the same issue.
- New contributors can pick up issues marked as
good first issue.
Conventional Commits format is required for all commits.
Go modules are used for managing dependecies. After adding new or removing exitsting depenencies please run
go mod tidy
to update go.mod and go.sum files.
UI is written using React, follow user guide for create-react-app to make changes to the UI code.
docker-compose up --build -d
admin:adminis the default creds for UI, Which can be changed in docker-compose file.
- Install go(1.16+), mysql-server, npm and yarn
- Start MySQL server (Default password should be set to
SecretPassword, or export datasource env variable) - Start both FE and BE
go run main.go
cd ui && yarn install && yarn start