Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 1.34 KB

File metadata and controls

47 lines (26 loc) · 1.34 KB

Contributing

Local Setup

  • Clone this repository.
  • Install nvm if you haven't previously used it
  • Install/set NodeJS version: nvm install
  • Install node dependencies: npm ci
  • Edit .env to set ENV=LOCAL
  • Run npm run watch to boot up local development server and build tools. Normally this would boot up localhost:3000, or whichever port is available.
  • Get some coffee. Shake up. Start coding :).

Build

Run npm run compile to compile all the source files into the public folder.

Run npm run zip to create a compressed zip file. This is saved as moveon.zip in the public folder.

Files and Directories

All the editable files are located inside the src folder.

The local server files are located inside the public folder.

Templates

Templates are twig files compiled into html through npx gulp pages. They are located in src/templates.

For Twig templating guides, please refer to their site.

Stylesheets

SASS-compiled stylesheets are located in src/styles.

Scripts

Scripts are located in src/scripts. Please apply the ES6 standards.

Images

Raw images are located in src/images. They are optimized on build.

Fonts

Fonts are located in src/fonts.