AM Comunications

Kickoff for web applications.

Main Tools

• Babel
• Sass
• Pug
• Gulp
• BrowserSync
• ESLint

First steps

Installing node

Get the latest version of node from the official website or using nvm Nvm approach is preferred. Also, you may find this tool useful to automate version changing between projects.

Getting the dev dependencies

Run npm install from rootpath of the project.

Gulp. The right way

During the project development you will probably use gulp every day, so let's use it in the right way. A very popular way of getting these kind of packages is simply tell npm to install them globally using the -g flag. That's needless as gulp is already included in this project dependencies. A big problem can have place if the version of the packages that were installed globally do not match the versions that each project require. The right way to execute these tools is using the binaries in the node_modules folder, that is node_modules/.bin/. To execute gulp just use the following in your terminal: ./node_modules/.bin/gulp. The same applies for other dependencies that have command line tools. Adding an alias in your .bashrc/.bash_profile for these tools is highly recommended:

alias gulp='node_modules/.bin/gulp'

Gulp

To start your app run gulp in the rootpath of the project. Then access your app at localhost:port. The port is logged in the console where you ran gulp.

Development

Environments

By default, the environment will be development, but you can easily change it using the env param in your gulp tasks: gulp --env production

SCSS

When creating SCSS files you don't need to import other files inside yours to use properties from them. There's a specific file called application.scss where every SCSS file should be imported in the desired priority order. This works just like the stylesheet elements in the head of an html, when repeated rules are present the rule that was imported last will override the other.

Vendors

To add a vendor simply install and save it using npm. Then add the path of the source files relative to the node_modules folder, to vendorJs.js or vendorCss.js depending on what you are adding. i.e: Adding jquery

npm install --save jquery

This will generate the jquery folder inside node_modules and add the register the dependency in the package.json file. Then, add the source file of jquery to vendorJs.js. It should look like this:

module.exports = [
  'jquery/dist/jquery.js',
];

Testing

Unit testing

We combine the power of Karma and Jasmine frameworks to develop our unit testing. You can find the configuration files in the test/unit folder and you can find the tests inside the test/unit/specs folder. To run these specs execute the following: npm run test

End to end tests

We combine the power of Protractor and Jasmine frameworks to develop our end to end tests. You can find the configuration files in the test/e2e folder and you can find the tests inside the test/e2e/specs folder.

The first time you are running the tests, you probably need to update webdriver. Use the following: ./node_modules/.bin/webdriver-manager update To run these specs against the url in the protractor conf execute the following: npm run protractor To run these specs against your development environment, execute the following: npm run protractor-local. This will hit the app in localhost:3000.

Deploy

S3

In order to deploy you must first create config/aws.js file with the credentials of the Amazon S3 bucket for each environment. The file needs to have to follow the format specified in config/aws.js.example

Then just run gulp s3 --env <environment name> with your desired env as parameter.

Finally, you need to add a custom routing rule so that s3 handles the 404 (or 403 depending or the bucket policy) to the s3 properties. In the Static Website Hosting panel, check the Enable website hosting option and complete the form with the following:

Index document: index.html

And add this redirect rule (Depending on the bucket policy the error code to handle can be either 404 or 403)

<RoutingRules>
    <RoutingRule>
        <Condition>
            <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
        </Condition>
        <Redirect>
            <ReplaceKeyPrefixWith>#/</ReplaceKeyPrefixWith>
        </Redirect>
    </RoutingRule>
</RoutingRules>

Further reading

Check the docs folder for extra help on usual tasks or issues:

• Adding new vendors
• Adding google analytics
• Troubleshooting
• Maintenance mode
• Webp assets
• Css regression testing

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

About

This project is maintained by Sebastian Balay and it was written by Wolox.

License

am-communications is available under the MIT license.

Copyright (c) 2015 Sebastián Balay <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.