deemix-webui/COMPILE-UI.md

66 lines
1.5 KiB
Markdown
Raw Normal View History

2020-05-08 18:57:15 +02:00
**NOTE: THIS FILE IS NEEDED JUST FOR DEVELOPERS OF THIS PROJECT, IF YOU AREN'T YOU CAN IGNORE IT**
2020-05-08 18:51:57 +02:00
This file explains how to compile files for the UI.
# What you need to do just the first time
2020-05-08 18:51:57 +02:00
1. Download and install Node.js, you can download it [here](https://nodejs.org/en/download/) (also installs npm)
2. Once you have finished to install Node.js, check if everything is ok by running
```console
$ node -v
```
and then
```console
$ npm -v
```
2020-05-07 21:55:25 +02:00
If you see the corresponding versions of node and npm, you are ready to code!
3. Go to the root of this project, open your favorite prompt and run
```console
$ npm i
```
# Scripts
2020-05-07 21:55:25 +02:00
## Development
By simply running
```console
$ npm run dev
```
you will have 2 tasks running at the same time:
2020-05-07 21:55:25 +02:00
- the Python server
- the [rollup](https://rollupjs.org/guide/en/) watcher pointing to the configured `.js` file and ready to re-bundle
2020-05-13 11:04:52 +02:00
**You can now go to http://127.0.0.1:9666 and see the app running.**
You can edit `.css` and `.js` files and simply refresh the page to see your new and surely awesome code directly in the app 😉
2020-05-08 18:51:57 +02:00
However, if you need to edit the `public/index.html` file you have to kill the terminal and re-run `npm run dev` to see your edits.
## Building
If you want to deploy your application, you have to run
```console
$ npm run build
```
2020-05-08 18:51:57 +02:00
This is necessary to get a bundled `.js` file **minified**, helping to drop the final application size.
# Other
If you notice that another team member installed one or more new packages, just run
```bash
$ npm i
```
2020-05-13 11:04:52 +02:00
and you will be ok