Skip to content

Commit

Permalink
chore: format readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
mvarendorff committed Jan 6, 2024
1 parent a34bcf5 commit 61d7e7e
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
12 changes: 6 additions & 6 deletions packages/cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This package contains the Payload CMS hosted at https://admin.yestheory.family.

## Important commands

- `yarn dev` runs the CMS in development mode, restarting on changes
- `yarn seed` inserts some basic data including an initial user based on the .env file into the database
- `yarn generate:types` generates TypeScript types based on the collection definitions (can be imported
as `import { type GeneratedTypes } from "payload";`)
- `yarn dev` runs the CMS in development mode, restarting on changes
- `yarn seed` inserts some basic data including an initial user based on the .env file into the database
- `yarn generate:types` generates TypeScript types based on the collection definitions (can be imported
as `import { type GeneratedTypes } from "payload";`)

## Requirements

- Needs both the database and typesense running to start
- Needs Node.js Backend launched after it to authenticate requests
- Needs both the database and typesense running to start
- Needs Node.js Backend launched after it to authenticate requests
4 changes: 2 additions & 2 deletions packages/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ functionality of the all the moving parts.

## Important commands

- `yarn playwright test` runs the testsuite against a currently running setup
- `yarn playwright test` runs the testsuite against a currently running setup

## Requirements

- A functional web application on port `http://localhost:3000` (can be changed using the env variable `FRONTEND_URL`)
- A functional web application on port `http://localhost:3000` (can be changed using the env variable `FRONTEND_URL`)
4 changes: 2 additions & 2 deletions packages/scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This package contains one-off scripts that are not bundled into any running appl

## Important commands

- `yarn tsx path/to/script` runs the given script
- `yarn tsx path/to/script` runs the given script

## Requirements

- Depend on the script
- Depend on the script
10 changes: 5 additions & 5 deletions packages/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ application. It uses [Prisma ORM](https://prisma.io) for connecting to the datab

## Important commands

- `yarn dev` runs the backend in development mode, restarting on changes
- `yarn prisma <prisma command>` interact with the database
- `yarn prisma db push` pushes the current schema into the database without migrations (used during development)
- `yarn prisma migrate dev` creates a new migration for the project (required for PRs when the schema changes)
- `yarn dev` runs the backend in development mode, restarting on changes
- `yarn prisma <prisma command>` interact with the database
- `yarn prisma db push` pushes the current schema into the database without migrations (used during development)
- `yarn prisma migrate dev` creates a new migration for the project (required for PRs when the schema changes)

## Requirements

- A running CMS (required because the backend stitches the CMS' schema)
- A running CMS (required because the backend stitches the CMS' schema)
12 changes: 6 additions & 6 deletions packages/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This package contains the Next.js Frontend that is displayed to the user when vi

## Important commands

- `yarn codegen` regenerates code based on the .graphql files in the package
- `yarn dev` runs the frontend in development mode, hot-reloading on changes (runs `yarn codegen` on first start)
- `yarn storybook` runs Storybook in development mode, hot-reloading on changes
- `yarn codegen` regenerates code based on the .graphql files in the package
- `yarn dev` runs the frontend in development mode, hot-reloading on changes (runs `yarn codegen` on first start)
- `yarn storybook` runs Storybook in development mode, hot-reloading on changes

## Requirements

*These requirements are for running the actual frontend; they don't apply to running Storybook*
_These requirements are for running the actual frontend; they don't apply to running Storybook_

- A running backend (required because the codegen fetches its schema from there)
- Typesense running when searching through group-chats
- A running backend (required because the codegen fetches its schema from there)
- Typesense running when searching through group-chats

0 comments on commit 61d7e7e

Please sign in to comment.