Billycraft

Disclaimers

• CI will be improved actually use Makefile to upload images on registry then go on the server and do ./update
• We cant do without entries in hostfile because cookies are not considered as secure with localhost

Prerequisite

• Node JS : 20.x.x
• Pnpm : >= 8
• Docker
• Rust (auth)
• Go (back)

Tools

• Swag to generate sdk with:
  • go install github.com/swaggo/swag/cmd/swag@latest
  • make generate-sdk when needed

Add in your host file (/etc/hosts):

127.0.0.1       auth.billycraft.lan api.billycraft.lan app.billycraft.lan

Folder structure

• docker-compose.yml : The docker-compose to mount the stack excluding front (to dev)
• auth: The auth server (auth.billycraft.fr)
• back: The Billycraft API (api.billycraft.fr)
• front: The Billycraft Application (app.billycraft.fr)
• deploy: files to deploy the app on a server
• docs: Some documentation
• www: The public website (billycraft.fr)
• Makefile: all you need to start the stack for back or front dev
• db: Just the init script when deploying a new db service
• package.json, pnpm-workspace.yaml, pnpm-lock.yaml : Use changeset to make versions and dependency management

Changeset used here !

When making changes run : pnpm changeset complete the command then add it in git commit to generate a changelog entry

---

Lets go dev

Here is all you need usually to dev auth, back, front or website

Setup env

• copy paste .env.dist into .env

Dev back and auth

• Start back and auth for the first time

make prepare # build dev images
make dev # or make up for detached process

• Then usually when you work on the api (no auth db changes) just do make dev

• Stop all (without cleaning db)

make down

• Cleaning database

make clean

Frontend

• By default it will start in staging mode. If you dev APIs switch to lan mode (see below)

cd front
pnpm install
pnpm start
# go to localhost:3000

Using lan mode

cd front
pnpm install
pnpm start:lan

WWW

• pnpm install : Install deps
• pnpm run dev : Launch vite server to dev

---

Release

You have a make command to deploy each services on registry then pull the images on the server.

• Login to docker registry with SCW_SECRET_KEY=XXXX ./deploy/login.sh

• Generate changelogs : pnpm changeset version

• Commit changes : git add . && git commit -m "chore: release" && git push

• Choose what you want to deploy

make auth-migrator-release
make auth-release
make back-release
make front-release
make front-stg-release
make www-release