From 61d7e7eb0b16c37cba07629210ebb643aefc0dfd Mon Sep 17 00:00:00 2001 From: geisterfurz007 Date: Sat, 6 Jan 2024 14:29:45 +0100 Subject: [PATCH] chore: format readmes --- packages/cms/README.md | 12 ++++++------ packages/e2e/README.md | 4 ++-- packages/scripts/README.md | 4 ++-- packages/server/README.md | 10 +++++----- packages/web/README.md | 12 ++++++------ 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/packages/cms/README.md b/packages/cms/README.md index c504336c..19774258 100644 --- a/packages/cms/README.md +++ b/packages/cms/README.md @@ -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 diff --git a/packages/e2e/README.md b/packages/e2e/README.md index 44a8105f..279a7986 100644 --- a/packages/e2e/README.md +++ b/packages/e2e/README.md @@ -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`) diff --git a/packages/scripts/README.md b/packages/scripts/README.md index a087f64e..dda8e199 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -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 diff --git a/packages/server/README.md b/packages/server/README.md index 84154896..ddc28903 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -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 ` 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 ` 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) diff --git a/packages/web/README.md b/packages/web/README.md index 5c4f52e0..2ef2540b 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -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