Project short description here. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
This file contains valuable points of contacts, development concepts, environments, features, workflow about this project. This is a handmade list that needs to be updated once the project is changed.
Please reach out to the team if you have any question or comments.
- First Last - Product Owner
- First Last - Back End Lead
- First Last - Front End Lead
- First Last - QA Lead
- ...
Find next some of the global application standards and best practices to understand and collaborate on this project.
Find next the project environments. Please update each environment based on the deployed date.
| Environment | URL | Updated |
|---|---|---|
| dev | dev.project.com | 05/20/2015 |
| prod | project.com | 05/20/2015 |
Find next some of the requirements and steps in order to get this project configure on your local environment.
Install or make sure you have installed:
Check Grunt version grunt -v or install it globally: npm install -g grunt-cli or
Check Bower version bower -v or install it globally: npm install -g bower.
Node.js, Git and Compass…
Clone the project on your development folder.
git clone ssh_url
Access your project folder
cd project_name
Install project dependencies
npm install
Install packages
bower install
See gruntfile.js for more development tasks.
Run project and preview in browser
grunt serve
Building project for production
grunt
This project is comprised of tools for improving your productivity and satisfaction when building a web project. See package.json for more information on what tools this project contains.
- Built-in preview server with LiveReload
- Automagically compile Sass files
- Automagically lint your scripts
- Awesome Image Optimization
- Foundation Framework - Bootstrap
- CSS extension language - Sass
- Modernizr builds
- Includes html5shiv and respond.js for IE8 and lower browsers
- ...
This changelog contains a curated, chronologically ordered list of notable changes for each version of the project.
Third-party dependencies are managed with bower-install. Add new dependencies using Bower and then run the Grunt task to load them:
bower install --save jquery
grunt bowerInstallThe components are installed in the root of the project at /bower_components. To reference them from the grunt serve web app index.html file, use src="bower_components" or src="/bower_components". Treat the references as if they were a sibling to index.html.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.