Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
krazkidd committed Oct 2, 2023
1 parent 6e6e8ec commit 85bd141
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,30 @@ License: AGPLv3 (see LICENSE.md file)

### Setup

To install dependencies and run the Vite development server:
To install dependencies:

```bash
npm install
```

To install the Firebase CLI, [follow these instructions](https://www.npmjs.com/package/firebase-tools#installation) or simply run:

```bash
npm install -g firebase-tools
```

To start the Firestore emulator and run the Vite development server:

```bash
firebase emulators:start
npm run dev
```

The server listens on http://localhost:3000/.

## Deployment

Only static Nuxt deployments (SSG) are supported at this time. This is due to a limitation in the way the Pinia and local storage Nuxt modules (i.e. the `defineStore()` and `useLocalStorage()` composables) work when Nuxt's server-side rendering (SSR) is enabled.

The basic problem is that hydration of the Pinia store on the client does not capture the locally-stored app state. Because of this, SSR is disabled with `ssr: false`. You may find additional details [here](https://github.com/krazkidd/lineup/pull/3).
Only static Nuxt deployments (SSG) are supported at this time (`ssr: false`). This allows us to deploy to some free static hosting services. See [Hosting](#hosting).

### Static Site Generation (SSG)

Expand Down

0 comments on commit 85bd141

Please sign in to comment.