From cb8f17be3e2b5bb948550687ff8ae31850f83b16 Mon Sep 17 00:00:00 2001 From: Paul Graffam Date: Tue, 29 Jan 2019 17:19:43 -0500 Subject: [PATCH] Clarified some portions, updated sections related to assets refactoring --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 01409b1..b58fbac 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ A basic boilerplate for a Three.js project including the use of Webpack and ES6 ``` build - Directory for built and compressed files from the npm build script src - Directory for all dev files -├── css - Contains all SCSS files, that are compiled to `src/public/assets/css` -├── js - All the Three.js app files, with `app.js` as entry point. Compiled to `src/public/assets/js` with webpack +├── css - Contains all SCSS files, that are compiled to `src/public/css` +├── js - All the Three.js app files, with `app.js` as entry point. Compiled to `src/public/js` with webpack │ ├── app │ │ ├── components - Three.js components that get initialized in `main.js` │ │ ├── helpers - Classes that provide ideas on how to set up and work with defaults @@ -16,7 +16,8 @@ src - Directory for all dev files │ │ └── model - Classes that set up the model object │ ├── data - Any data to be imported into app │ └── utils - Various helpers and vendor classes -└── public - Used by webpack-dev-server to serve content and is copied over to build folder with build command. Place external vendor files here. +└── public - Used by webpack-dev-server to serve content. Webpack builds local dev files here. + └── assets - Is copied over to build folder with build command. Place external asset files here. ``` ## Getting started @@ -39,18 +40,18 @@ Spins up a webpack dev server at localhost:8080 and keeps track of all js and sa npm run build ``` -Cleans existing build folder while linting js folder and then copies over the public folder from src. Then sets environment to production and compiles js and css into build. +Cleans existing build folder while linting js folder and copies over the public assets folder from src. Then sets environment to production and compiles js and css into build. ## Other NPM Scripts -You can run any of these individually if you'd like with the npm run command: -* prebuild - Cleans build folder and lints `src/js` -* clean - Cleans build folder -* lint - Runs lint on `src/js` folder and uses `.eslintrc` file in root as linting rules -* webpack-server - Create webpack-dev-server with hot-module-replacement -* webpack-watch - Run webpack in dev environment with watch -* dev:js - Run webpack in dev environment without watch -* build:dir - Copy files and folders from `src/public` to `build` -* build:js - Run webpack in production environment +You can run any of these individually if you'd like with the `npm run` command: +* `prebuild` - Cleans up build folder and lints `src/js` +* `clean` - Cleans build folder +* `lint` - Runs lint on the `src/js` folder and uses the `.eslintrc` file in root for linting rules +* `webpack-server` - Start up a webpack-dev-server with hot-module-replacement +* `webpack-watch` - Run webpack in dev environment with watch +* `dev:js` - Run webpack in dev environment without watch +* `build:dir` - Copy files and folders from `src/public` to `build` +* `build:js` - Run webpack in production environment ## Input Controls * Press H to hide dat.GUI