Found an issue? File it on jira
- Install Node.js
- on OSX use homebrew
brew install node
- on Windows use chocolatey
choco install nodejs
-
Install these NPM packages globally
npm install -g bower gulp
Refer to these instructions on how to not require sudo for npm
-
Run the project with
npm start
-
This injects the bower components, compiles sass, and runs the server on port
3000
-
Open your browser and point it to http://localhost:3000
This will minify, concatenate files, cachebust, compile sass, and copy all relevant
assets to a folder under ./dist/build
.
- Run
gulp build --dist
This currently only renames the index.html
to index.php
.
- add the
--production
flag:gulp build --dist --production
.
- Install these atom packages with apm
apm install <packages name>
- Linting
linter
linter-jscs
linter-jshint
editorconfig
- Spelling
linter-Spell
linter-spell-javascript
- Snippets
angularjs
angularjs-snippets
autoclose-html
- Highlighting
pigments
highlight-selected
- Theme
file-icons
minimap
minimap-highlight-selected
- VCS
open-on-bitbucket
git-time-machine
merge-conflicts
TODO: describe the folder Structure.
src
├── app
│ ├── components
│ │ ├── cart
│ │ ├── favorites
│ │ ├── footer
│ │ ├── menu
│ │ │ └── partials
│ │ ├── search
│ │ ├── top
│ │ │ └── partials
│ │ └── ui
│ ├── core
│ │ └── services
│ └── pages
│ ├── 404
│ ├── about
│ ├── account
│ │ └── login
│ ├── brands
│ ├── category
│ │ └── partials
│ ├── checkout
│ │ └── success
│ │ └── popup+deliveryplace
│ ├── contact
│ ├── jobs
│ ├── latest
│ ├── product
│ │ ├── colors
│ │ └── partials
│ ├── reviews
│ ├── start
│ ├── stickers
│ │ ├── directives
│ │ └── thanks
│ ├── style
│ ├── stylecreator
│ ├── terms
│ ├── thanks
│ └── work
│ └── partials
└── design
├── assets
│ ├── fonts
│ │ ├── icons-clothes
│ │ ├── icons-general
│ │ └── notera
│ ├── images
│ └── sass
└── compiled_css
TODO: describe the existing modules.
app --> [
app.module1 --> [
app.core,
app.widgets
],
app.module2 --> [
app.core,
app.widgets
],
app.moduleN --> [
app.core
],
app.widgets,
app.core --> [
ngAnimate,
ngSanitize,
ui.router,
blocks.exception,
blocks.logger,
blocks.router
]
]
TODO: describe the existing modules.
This module does something
TODO: describe the existing gulp tasks.
-
gulp help
Displays all of the available gulp tasks.
-
gulp vet
Performs static code analysis on all javascript files. Runs jshint and jscs.
-
gulp test
Runs all unit tests using karma runner, mocha, chai and sinon with phantomjs. Depends on vet task, for code analysis.
-
gulp clean-code
Remove all javascript and html from the build folder
-
gulp templatecache
Create an Angular module that adds all HTML templates to Angular's $templateCache. This pre-fetches all HTML templates saving XHR calls for the HTML.
-
gulp templatecache --verbose
Displays all files affected by the task.