• Koa 2
• Prisma with PlanetScale
• Zod

If you have already completed the setup steps below, you can get started with:

npm run dev

This project uses Votla instead of NVM for managing Node versions. Install Volta on your machine with the steps below.

See Volta > Getting Started

Install Volta with Chocolatey via:

choco install volta

Note: this should be done in a shell with admin permissions.

Make a copy of the .env.example file in the project root. Name your local copy .env.local. This file will not be checked in. Some values in your .env.local may need to be filled in from project secrets.

This project interacts with the Planetscale database with the Prisma CLI. This CLI is a Node application, and can generally be used with npx without needing to globally install it.

Some useful commands:

# Browse your data
npx prisma studio

# Push the Prisma schema state to the database
npx prisma db push

# Pull the schema from an existing database, updating the Prisma schema
npx prisma db pull

💡 Notes on prisma migrate.

Making schema changes with db push. When you merge a development branch into your production branch, PlanetScale will automatically compare the two schemas and generate its own schema diff. This means that Prisma's [prisma migrate](https://www.prisma.io/docs/concepts/components/prisma-migrate) workflow, which generates its own history of migration files, is not a natural fit when working with PlanetScale. These migration files may not reflect the actual schema changes run by PlanetScale when the branch is merged.

Prisma recommends not using prisma migrate when making schema changes with PlanetScale. Instead, we recommend that you use the prisma db push command.

For an example of how this works, see How to make schema changes with db push

This project is deployed on Fly. The Fly CLI is useful from time to time.

Some useful commands:

# Auth yourself
fly auth login

## Commands to interact with all FitPlot apps
fly apps list

## Commands to interact with this app
# View deployment status
fly status
# Ping this app
fly ping
# List project environment variables and secrets
fly secrets list
# Attach to reatime logs in the cloud
fly logs

Note: Releases are handled via ci/cd. This project should not be deployed from your local machine with a fly deploy command.

This project reads data on Planetscale. The Planetscale CLI is used to scale, branch, and interact with the database.

Some useful commands:

# Auth yourself
pscale auth login

# Database branching
pscale branch list
pscale branch create
pscale branch switch
pscale branch delete

There are lots of gotchas with using Prisma with Planetscale. Be sure to check out the Using Prisma with Planetscale guide every time.

When upgrading the Node version for the project, the Node version should be pinned to the package with:

volta pin node@x.x.x

⚠️ Additionally, the Node version should be updated in the root Dockerfile.