Mirror/filesafe
1
0
Fork 0
mirror of https://github.com/BobbyWibowo/lolisafe.git synced 2025-01-18 01:11:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: README.md

Browse Source
This commit is contained in:
Bobby 2023-12-17 21:12:56 +07:00
parent 733300d36f
commit 2c47e6df1d
No known key found for this signature in database
GPG Key ID: B2F45B6A3C9A8FCA
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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).