Development

Environment setup

You need to have Go, Node.js, Docker, and Docker Compose (comes pre-installed with Docker on Mac and Windows) installed on your computer.

Verify the tools by running the following commands:

go version
npm --version
docker --version
docker-compose --version

Start on local machine

Start in development mode

From kicad-api directory run the command (you might need to prepend it with sudo depending on your setup):

docker-compose up

This starts a kicad specific containers required by server.

Navigate to the server folder and start the back end:

cd server
go run server.go

The back end will serve on http://localhost:8080.

Navigate to the webapp folder, install dependencies, and start the front end development server by running:

cd webapp
npm install
npm run dev

The application will be available on http://localhost:5173.