diff options
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/getting-started.md | 4 | ||||
| -rw-r--r-- | docs/dev/webpack.md | 9 |
2 files changed, 10 insertions, 3 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 07524971..9a35b71a 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -18,7 +18,7 @@ Developer Notes Now that everything is in place, we can start CodiMD: -4. `npm run build` will build the frontend bundle. It uses webpack to do that. +4. `yarn run build` will build the frontend bundle. It uses webpack to do that. 5. Run the server with `node app.js` @@ -32,7 +32,7 @@ rebuild the frontend or restart the server if necessary. The commands will stay active in your terminal, so you will need multiple tabs to run both at the same time. -4. Use `npm run dev` if you want webpack to continuously rebuild the frontend +4. Use `yarn run dev` if you want webpack to continuously rebuild the frontend code. 5. To auto-reload the server, the easiest method is to install [nodemon](https://www.npmjs.com/package/nodemon) and run `nodemon --watch app.js --watch lib --watch locales app.js`. diff --git a/docs/dev/webpack.md b/docs/dev/webpack.md index b05fd1d3..3d35b28a 100644 --- a/docs/dev/webpack.md +++ b/docs/dev/webpack.md @@ -7,7 +7,14 @@ about it on [the webpack website](https://webpack.js.org/). Here's how we're using it: ## `webpack.common.js` -This file contains all common definition for chunks and plugins, that are needed by the whole app. +This file contains all common definitions for chunks and plugins that are needed by the whole app. + +The various entrypoints under the `entry` key define groups of files (npm packages or .css/.js files directly from this project) that need to be included together to be useful. +The `index` group for example bundles all javascript files and libraries used for the note editor. + +Entrypoints are referenced in the `plugins` section. +The `HtmlWebpackPlugin` uses templates in `public/views/includes` to include the path to the generated resources in new templates under `public/views/build`. These templates are then used by the backend to serve HTML to the browser. + **TODO:** Document which entry points are used for what. |