Changeset View
Changeset View
Standalone View
Standalone View
README.md
Show First 20 Lines • Show All 45 Lines • ▼ Show 20 Lines | |||||
* pygments | * pygments | ||||
* pypandoc | * pypandoc | ||||
* python-dateutil | * python-dateutil | ||||
* pyyaml | * pyyaml | ||||
* requests | * requests | ||||
To compile the frontend assets, you need to have [nodejs](https://nodejs.org/en/) >= 8.x and [yarn](https://yarnpkg.com/en/) installed. If you are on Debian stretch, you can easily install an up to date nodejs from the stretch-backports repository while packages for yarn can be installed by following [these instructions](https://yarnpkg.com/en/docs/install#debian-stable). | To compile the frontend assets, you need to have [nodejs](https://nodejs.org/en/) >= 8.x and [yarn](https://yarnpkg.com/en/) installed. If you are on Debian stretch, you can easily install an up to date nodejs from the stretch-backports repository while packages for yarn can be installed by following [these instructions](https://yarnpkg.com/en/docs/install#debian-stable). | ||||
Once you have installed nodejs, issue the following command in the root directory of swh-web in order to retrieve all the frontend dependencies: | Alternatively, you can install yarn with `npm install yarn`, and add `YARN=node_modules/yarn/bin/yarn` as argument whenever you run `make`. | ||||
``` | |||||
$ yarn install | |||||
``` | |||||
Please note that the static assets bundles generated by webpack are not stored in the git repository. Follow the instructions below in order to generate them in order to be able to run the frontend part of the web applications. | Please note that the static assets bundles generated by webpack are not stored in the git repository. Follow the instructions below in order to generate them in order to be able to run the frontend part of the web applications. | ||||
### Make targets | ### Make targets | ||||
Below is the list of available make targets that can be executed from the root directory of swh-web in order to build and/or execute the web applications under various configurations: | Below is the list of available make targets that can be executed from the root directory of swh-web in order to build and/or execute the web applications under various configurations: | ||||
* **run-django-webpack-devserver**: Compile and serve not optimized (without mignification and dead code elimination) frontend static assets using [webpack-dev-server](https://github.com/webpack/webpack-dev-server) and run django server with development settings. This is the recommended target to use when developing swh-web as it enables automatic reloading of backend and frontend part of the applications when modifying source files (*.py, *.js, *.css, *.html). | * **run-django-webpack-devserver**: Compile and serve not optimized (without mignification and dead code elimination) frontend static assets using [webpack-dev-server](https://github.com/webpack/webpack-dev-server) and run django server with development settings. This is the recommended target to use when developing swh-web as it enables automatic reloading of backend and frontend part of the applications when modifying source files (*.py, *.js, *.css, *.html). | ||||
Show All 28 Lines |