Skip to content

Latest commit

 

History

History
80 lines (47 loc) · 3.01 KB

README.md

File metadata and controls

80 lines (47 loc) · 3.01 KB
Raw

Backstage 🕺

Setup

Optional

You'll need certain environment variables to run Bedrock's functionality in local development. The first step is to:

  • Sign up for Stripe, used for payments
  • Sign up for Postmark, used for sending emails

Steps 🏎️

Copy .env.example to .env and fill out the .env file with your environment variables!

cp .env.example .env

Note: do not delete the .env.example file, as it's used by some code generation processes and is useful for potential future team members as a reference.

Now you're ready to set everything up locally:

  1. Install Docker by following their installation instructions for your OS. Backstage uses Docker to start the local development database.

  2. Then, install the dependencies with yarn:

yarn
  1. Start the local development database as well as the Stripe CLI webhook listener (to make payments work) with docker-compose:
docker-compose up

  1. Copy the webhook secret that the Stripe CLI logged, something like "> Ready! Your webhook signing secret is whsec_***". Copy that secret and add it to your .env file.

  2. Migrate your local development database to the base schema:

yarn prisma:migrate

Development workflow 🧑‍💻

To develop your app, you always need to have two commands running concurrently:

  1. Start the development database with:
docker-compose up
  1. Start the development process, which also runs all the necessary code generators:
yarn dev

That's it! Now you should have Backstage running locally and should be able to visit http://localhost:3000 🎉

Scripts

The three most important commands you'll run frequently during development:

  • yarn generate: Generates the Prisma client (docs), which Nexus uses and generates the GraphQL schema (docs), which GraphQL Codegen uses and generates the urql hooks (docs). Run this whenever you change the database schema, GraphQL schema or GraphQL queries.

  • yarn prisma:migrate: Creates migration files from your Prisma schema changes and runs those migrations on your local dev db (docs). Run this whenever you change your database schema.

  • yarn prisma:studio: Starts Prisma Studio on localhost:5555 where you can inspect your local development database.

  • yarn cypress:open: Opens Cypress so you can write and run your end-to-end tests. (docs)

All the others are used in CI or by those three main scripts, but you should only rarely need to run them manually.

For more information, check out the in-depth docs