# <%= appName %>

## Setup

- Clone this repo.

- Install dependencies:
  - Use `npm ci` if you're not altering the dependency list or changing the versions of your dependencies.
  - Alternatively, use `npm install` if you've altered the dependency list or changed the version of one of your dependencies. This is also necessary if you change the app's version number.

- Run the app:
  - Use `npm run production` to run in production mode.
    - Available shorthands:
      - `npm run prod`
      - `npm run p`
      - `npm start`
  - Use `npm run development` to run in development mode.
    - Available shorthands:
      - `npm run dev`
      - `npm run d`
  - Use `npm run production-proxy` to run the app in production mode, but with `localhostOnly` set to true and `hostPublic` set to false. This mode will make it so your app only listens to requests coming from localhost and does not serve anything in the public folder. This mode is useful when you want to host your app behind a reverse proxy from a web server like Apache or nginx and [is considered a best practice for Node.js deployments](https://expressjs.com/en/advanced/best-practice-performance.html#use-a-reverse-proxy).
    - Available shorthands:
      - `npm run prodproxy`
      - `npm run x`
  - See [docs](https://github.com/rooseveltframework/roosevelt) for more information about configuring and running the app.