Skip to content

Commit d912f23

Browse files
committed
docs: update readme
1 parent 77018da commit d912f23

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ This project has been setup to use ESM Node. This allows us to use ES6 imports i
3838

3939
This uses [tsx](https://github.com/esbuild-kit/tsx) as a dev server and [pkgroll](https://github.com/privatenumber/pkgroll) to bundle and build the project.
4040

41-
Note: Prisma does not support ESM by default and [have an open issue](https://github.com/prisma/prisma/issues/5030) -- looking to migrate this to another ORM (drizzle) for ESM support
41+
Note: Prisma does not support ESM by default and [have an open issue](https://github.com/prisma/prisma/issues/5030) -- looking to migrate this to another ORM (drizzle) for ESM support.
42+
43+
"the Prisma client relies on globals like `__dirname` that used to be part of Node but in ESM have been moved to import.meta.dirname. See: https://stackoverflow.com/questions/46745014/alternative-for-dirname-in-node-js-when-using-es6-modules"
44+
45+
As a result of this it's best to stick to the `.cjs` format when running in production.
4246

4347
## Setup
4448

@@ -65,6 +69,16 @@ It's also recommended to install the [vitest extension for vscode](https://marke
6569

6670
## Build with docker
6771

72+
### locally
73+
74+
The `GOOGLE_APPLICATION_CREDENTIALS` env variable is mapped to the docker container from your home directory. This is required for the firebase admin sdk to verify the token and decode the claims. see the [Firebase Auth](#firebase-auth) section for more info on the service account key file and Google Application Credentials.
75+
76+
```
77+
docker compose up -d
78+
```
79+
80+
### production
81+
6882
```
6983
# build the app
7084
npm run build

0 commit comments

Comments
 (0)