You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+64Lines changed: 64 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,3 +105,67 @@ new Workflow({
105
105
},
106
106
}).listen();
107
107
```
108
+
109
+
## Development
110
+
111
+
> **Warning**
112
+
> All the following commands should be launched from the **monorepo root directory**
113
+
114
+
1. Install the dependencies.
115
+
```bash
116
+
pnpm install
117
+
```
118
+
You also have to copy the example .env.example:
119
+
```sh
120
+
cp .env.example .env
121
+
cp .env.example .env.docker
122
+
```
123
+
2. Start the postgresql docker container
124
+
```bash
125
+
pnpm run docker:db
126
+
```
127
+
>**Note:** The npm script will completewhile Docker sets up the container in the background. Ensure that Docker has finished and your container is running before proceeding.
128
+
129
+
3. Generate prisma schema
130
+
```bash
131
+
pnpm run generate
132
+
```
133
+
4. Run the Prisma migration to the database
134
+
```bash
135
+
pnpm run db:migrate:deploy
136
+
```
137
+
5. Run the first build (with dependencies via the `...` option)
138
+
```bash
139
+
pnpm run build --filter=webapp...
140
+
```
141
+
**Running simply `pnpm run build` will build everything, including the NextJS app.**
142
+
6. Run the Remix dev server
143
+
```bash
144
+
pnpm run dev --filter=webapp
145
+
```
146
+
## Tests, Typechecks, Lint, Install packages...
147
+
Check the `turbo.json` file to see the available pipelines.
148
+
- Run the Cypress tests and Dev
149
+
```bash
150
+
pnpm run test:e2e:dev --filter=webapp
151
+
```
152
+
- Lint everything
153
+
```bash
154
+
pnpm run lint
155
+
```
156
+
- Typecheck the whole monorepo
157
+
```bash
158
+
pnpm run typecheck
159
+
```
160
+
- Test the whole monorepo
161
+
```bash
162
+
pnpm run test
163
+
or
164
+
pnpm run test:dev
165
+
```
166
+
- How to install an npm package in the Remix app ?
167
+
```bash
168
+
pnpm add dayjs --filter webapp
169
+
```
170
+
- Tweak the tsconfigs, eslint configs in the `config-package` folder. Any package or app will then extend from these configs.
0 commit comments