openstapps/README.md

Open StApps Monorepo

Refer to the contribution guide

Projects

Apps

Name	Version	License	Readme
Core			frontend/app
Backend			backend/backend
Proxy			backend/proxy
Database			backend/database

Libraries

Name	Version	License	Readme
Core			packages/core
API			packages/api
API Plugin			packages/api-plugin
Logger			packages/logger
Core Tools			packages/core-tools

Publishing

After having added all changes using pnpm changeset

pnpm publish-packages

Internally, this will run

pnpm changeset version # bump versions
pnpm syncpack:fix
pnpm format:fix # changes to the package.json can cause issues
pnpm install # update lockfile and rebuild packages
git add .
git commit -m "refactor: update changelog"
pnpm changeset tags
git push --follow-tags
# from here the pipeline will do the publishing

Remote caching

Turbo supports remote caching, which massively speeds up build processes.

Connecting to the remote cache locally

.env.local

TURBO_API=http://example:3000
TURBO_TEAM=openstapps
TURBO_TOKEN=abc123

Connecting to the remote cache in GitLab Pipelines

You will need to define

• TURBO_API
• TURBO_TEAM
• TURBO_TOKEN Like you did locally as described in this guide.

Hosting a cache

Self-hosting via Docker is extremely simple, just follow this guide or in short:

.env

PORT=...
TURBO_TOKEN=...

docker run --env-file=.env -p 3000:3000 fox1t/turborepo-remote-cache

Useful commands

Why is this package bloating the app?

pnpm why --prod -r --filter @openstapps/app PACKAGE

Licenses

pnpm licenses --prod --filter PROJECT