Mercurial > kallithea
changeset 8444:850f096505ac stable
docs: mention the npm dependency more clearly (Issue #345)
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Thu, 11 Jun 2020 20:16:32 +0200 |
| parents | b688a2a1b189 |
| children | 0bca9e828db2 |
| files | docs/overview.rst docs/setup.rst |
| diffstat | 2 files changed, 8 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/overview.rst Mon Jun 08 16:05:21 2020 +0200 +++ b/docs/overview.rst Thu Jun 11 20:16:32 2020 +0200 @@ -141,9 +141,11 @@ but build the Kallithea package itself locally instead of downloading it.) .. note:: - Kallithea includes front-end code that needs to be processed first. - The tool npm_ is used to download external dependencies and orchestrate the - processing. The ``npm`` binary must thus be available. + Kallithea includes front-end code that needs to be processed to prepare + static files that can be served at run time and used on the client side. The + tool npm_ is used to download external dependencies and orchestrate the + processing. The ``npm`` binary must thus be available at install time but is + not used at run time. Web server
--- a/docs/setup.rst Mon Jun 08 16:05:21 2020 +0200 +++ b/docs/setup.rst Thu Jun 11 20:16:32 2020 +0200 @@ -54,7 +54,9 @@ but when trying to do a push it will fail with permission denied errors unless it has write access. -Finally, prepare the front-end by running:: +Finally, the front-end files must be prepared. This requires ``npm`` version 6 +or later, which needs ``node.js`` (version 12 or later). Prepare the front-end +by running:: kallithea-cli front-end-build