Skip to content

Commit

Permalink
fix: Adds a new section on building the app for production. (#11)
Browse files Browse the repository at this point in the history
* fix: Adds a new section on building the app for production.

* fix: pnpm format
  • Loading branch information
pettermachado authored Oct 8, 2024
1 parent dd81e6b commit a5143dd
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,19 @@ cp .env.sample .env

This app does not enforce any authentication, **do not put this app on the internet**.

### Building

The app contains two moving parts as described in [Project setup](#project-setup): the user facing React app and the server. These two needs to be built separately. To produce JavaScript files that can be run with plain `node` you can run the follwing two scrips defined in `package.json`.

- `pnpm build:remix` Builds the React app and puts the final output in `./build`.
- `pnpm build:server` Builds the server and puts it in `./build-server`. This step depends on the `pnpm build:remix` step.

After successfully running the commands above the app can be started with

```shell
node ./build-server/server.js
```

### App container

Every running environment is different, but to help getting this app deployed `./example.Dockerfile` will produce an image that runs the app.
Expand Down

0 comments on commit a5143dd

Please sign in to comment.