Skip to content

Commit

Permalink
init getting started section
Browse files Browse the repository at this point in the history
  • Loading branch information
sitek94 committed Nov 26, 2023
1 parent 67e76bc commit c8b2fd1
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- [x] build and deploy Storybook
- [x] set unified path aliases for all apps and shared libs (done for `apps/`, because `libs/` probably don't need them anyway)
- [x] add unused imports plugin to eslint
- [ ] research if it's worth using `turbo` - probably yes, to make it easier to run tasks that depend on each other
- [x] research if it's worth using `turbo` - probably yes, to make it easier to run tasks that depend on each other
- [ ] create diagram
- [ ] setup renovate

Expand All @@ -31,6 +31,37 @@
| Remix | https://pnpm-monorepo-remix.fly.dev/ |
| Docs (Storybook) | https://6562c63f0bbf6184dd3b3f1e-aulbjawzef.chromatic.com |

## Getting started

### Pre-requisites

- [pnpm](https://pnpm.io/installation)
- [Docker](https://docs.docker.com/get-docker/)

### Install dependencies

```sh
pnpm install
```

### Database

```sh
docker compose up mongo
```

### Run NestJS app

```sh
pnpm develop:nestjs
```

### Run Remix app

```sh
pnpm develop:remix
```

## References

- https://pnpm.io/next/filtering
Expand All @@ -41,4 +72,4 @@
- https://github.com/vercel/turbo/tree/main/examples - turbo repo examples
- https://github.com/storybookjs/storybook
- https://storybook.js.org/tutorials/design-systems-for-developers/react/en/architecture/
-
- https://turbo.build/repo/docs/getting-started/existing-monorepo

0 comments on commit c8b2fd1

Please sign in to comment.