Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.46 KB

🚀 Contributing Manual

This project is open to contributions from all levels and any help is appreciated!

Tip

For new contributors: Take a look at https://github.com/firstcontributions/first-contributions for a simple quick start guide on GitHub contributions.

Development

Prerequisites

Install the following tools for the project:

  • Go - API server (core)
  • gcc - Required for CGO in Go (core)
  • Bun - JavaScript runtime (dashboard, tracker)
  • Taskfile - Global task runnner

We recommend using mise-en-place as a convenient version manager tool for all the languages and tools required for this project.

Setup

We use Taskfile to run scripts and tasks to simplify the development process. Please refer to each sub-project's Taskfile for understanding the available tasks.

A full development setup can be done by running the following commands in separate terminals:

cd ./core
task dev -- start # Start API server
cd ./dashboard
task dev # Start dashboard dev server with HMR

More details on the development setup can be found in the respective sub-project READMEs.