Skip to content

Commit

Permalink
chore: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BobbyWibowo committed Dec 17, 2023
1 parent 733300d commit 2c47e6d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,16 @@ Please make sure your config matches the sample in `config.sample.js` before sta
5. Copy `views/_globals.sample.njk` as `views/_globals.njk`.
6. Modify front-end strings and options if desired.
7. Run `yarn install --production` to install all production dependencies.
8. Run `yarn start` to start lolisafe.
8. Run `yarn start` to start lolisafe. Alternatively, you can also start lolisafe with `yarn pm2` if you have [PM2](https://pm2.keymetrics.io/) installed.

> [!NOTE]
> If you see errors related to [sharp](https://github.com/lovell/sharp) engines upon starting lolisafe, try to run `yarn install --production --ignore-engines` first.
> [!IMPORTANT]
> Default admin/root account:
> Username: `root`
> Password: `changeme`
You can also start it with `yarn pm2` if you have [PM2](https://pm2.keymetrics.io/).

When running in production mode, lolisafe will use pre-built client-side CSS/JS files from `dist` directory, while the actual source codes are in `src` directory.

The pre-built files are processed with [postcss-preset-env](https://github.com/csstools/postcss-preset-env), [cssnano](https://github.com/cssnano/cssnano), [bublé](https://github.com/bublejs/buble), and [terser](https://github.com/terser/terser), and done automatically with [GitHub Actions](https://github.com/BobbyWibowo/lolisafe/blob/safe.fiery.me/.github/workflows/build.yml).
Expand Down

0 comments on commit 2c47e6d

Please sign in to comment.