You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
1 year ago | |
---|---|---|
public | 1 year ago | |
src | 1 year ago | |
.env | 1 year ago | |
.gitignore | 1 year ago | |
README.md | 1 year ago | |
gulpfile.js | 1 year ago | |
package-lock.json | 1 year ago | |
package.json | 1 year ago |
README.md
LSM Gulp Sample
Quickstart
- Copy the contents of this repo into a new project folder.
- Using the command line, run
npm install
from the project root. - For development, run
npm run start
; hot-reloading is enabled. - Replace and edit files as needed (see details below).
- To deply, run
npm run build
, and deploy thepublic
folder.
Development
HTML
- Adjust as needed within
src
. - Additional HTML files can be added to the
src
directly, or to subfolders withinsrc
. - Preserve the
styles.css
reference in the header. - Preserve the
app.js
reference near the closing</body>
tag.
Styles
- During development, write styles in SCSS, from
src/style
. - Add files as needed.
- Files will be concatenated during the build process, and compiled to CSS.
JS
- Scripts should be added to
src/js
, and any new script files imported insrc/index.js
. - ES6 modules can be used.
- Files will be concatenated and compiled into
app.js
, referenced byindex.html
.
Editing the public folder
- The files in the public folder that are deployed can be edited directly.
- These files are tracked by git.
- If you work with someone who only edits the public folder directly, you will need to keep track of changes they make, and incorporate what they do into the appropriate files within
src
.