diff --git a/README.md b/README.md index 240569f..7439e20 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,43 @@ -# Turborepo starter +# Dependencies to run -This Turborepo starter is maintained by the Turborepo core team. +- postgres +- bun +- setup biome in ide / editor -## Using this example +## env -Run the following command: - -```sh -npx create-turbo@latest +```env +DATABASE_URL = "postgresql://concord_user:concord_test@localhost:5432/concord_db" ``` -## What's inside? +# Running -This Turborepo includes the following packages/apps: - -### Apps and Packages - -- `docs`: a [Next.js](https://nextjs.org/) app -- `web`: another [Next.js](https://nextjs.org/) app -- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications -- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo - -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). - -### Utilities - -This Turborepo has some additional tools already setup for you: - -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting - -### Build - -To build all apps and packages, run the following command: +## API +```bash +cd apps/api +bun run dev ``` -cd my-turborepo +## DB -# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) -turbo build - -# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager -npx turbo build -yarn dlx turbo build -pnpm exec turbo build +```bash +cd packages/database +bun run db:generate +bun run db:migrate +bun run db:push +bun run db:seed +bun run db:studio # optional ``` -You can build a specific package by using a [filter](https://turborepo.com/docs/crafting-your-repository/running-tasks#using-filters): +## Linting and Fixing +```bash +bunx turbo format-and-lint # view linting and formatting suggestions, without writing +bunx turbo format-and-lint:fix # write fixes ``` -# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) -turbo build --filter=docs +## Alternatively -# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager -npx turbo build --filter=docs -yarn exec turbo build --filter=docs -pnpm exec turbo build --filter=docs +All commands for DB and API can be run from repo root with: +```bash +bunx turbo