The website codebase for admin.streetsupport.net.
Please work in the develop branch first, and use feature branches for significant pieces of work. Once the feature is completed, submit a pull request into develop. Travis CI automatically builds on each commit to develop, uat and prod. The prod branch automatically builds to: http://admin.streetsupport.net.
- vulnerabilities -
- develop -
- staging -
- release -
- Install Node 8 LTS,
- Run in Terminal:
npm i gulp-cli -g(Gulp does not need to be installed globally), - In your command line terminal, navigate to the street support project folder,
- Run:
npm i. (if this throws errors around Snyk (most likely Windows), see this link).
See https://github.com/fephil/garrus for more information about the Frontend workflow.
In your editor of choice, the following plugins are recommended but not required. Note the plugin names might be slightly different depending on your editor.
- editorconfig,
- tabs-to-spaces,
- linter,
- linter-handlebars,
- linter-js-standard,
- linter-stylelint.
Run these tasks in your command line Terminal:
gulp [--production] [--debug]
gulp deploy [--production] [--debug]
gulp auditcode
- The
gulptask builds the website, watches for changes and starts up a sever, - The
gulp deploytask builds the website without watching for changes or running the server, - The
gulp auditcodetask runs various linting on the project source files, - The
gulp jsdevtask only checks and builds javascript with associated tests, - The
--productionflag builds minified assets with no sourcemaps, - The
--debugflag shows the files being created in each task (if the task has a pipe).
On running the default gulp task from the terminal, it will run tests and linting, build the site into the /_dist/ directory, and then launch in your default browser. As you edit files in the /src/ directory, the site will refresh automatically.
Each page of the site is found under the /pages/ directory. Each page is represented by a handlebars file index.hbs, in a directory named after the page's url. In each .hbs file, meta data is entered to define the page:
- title: the page's title tag
- description: the page's meta description
- layout: the master layout file (found in
/layouts/) - permalink: ???
- jsBundle: the js bundle that will be loaded into the page. Bundles are defined in
/webpack.config.jsand each one points to a js file in/src/js/. For basic pages, usegeneric. - section: the top level navigation item this page belongs to. See
/src/scss/modules/_variables.scssfor list of sections - page: the navigation item for this page. See
/src/scss/modules/_variables.scssfor list of pages - nosubnav: {true|false} if
true, hide the sub navigation on the page
Page templating is done using Hogan. Note: template parts need to be escaped eg:
\{{myVariable}}
Knockout data-binding is also used in some pages.
Page code-behinds are written in plain ol' Javascript, or use Knockout. Knockout view models are found in /js/models/ are mostly tested. ES2015 syntax is transpiled using Babel.
For dev against a local dev API:
- Update the index in
src/js/env.jsto0connect tolocalenv. - Update the local url in
src/js/api-endpointsto your local environment API url e.g.var local = 'http://localhost:8080'
Tests reside in the /spec directory, and are written using Jasmine and Sinon. Please ensure any features submitted via pull request are covered by tests.
With the env variable set to dev (1), you can use the following login credentials:
[email protected]the password for this account will be distributed via slack at our dev meetups, and reset after each event.
CSS styling is written in Sass, based on Susy, in the BEM style, and is auto-prefixed. Build with a mobile-first approach, using sass-mq for media queries. Each component's styles should reside in its own file. Avoid nesting of elements and modifiers (although there are many cases of nesting at the moment!).