https://github.com/useallfive/drunn
https://github.com/useallfive/drunn
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/useallfive/drunn
- Owner: UseAllFive
- Created: 2014-06-26T22:24:39.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-06-27T01:03:47.000Z (almost 12 years ago)
- Last Synced: 2024-12-20T07:07:35.902Z (over 1 year ago)
- Language: Python
- Size: 3.77 MB
- Stars: 0
- Watchers: 17
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
base-marionette
===============
[](https://magnum.travis-ci.com/UseAllFive/base-marionette)
## Getting started
```BASH
npm install
bower install
grunt python
grunt
```
### Annotated Source
We use [groc](http://nevir.github.io/groc) to generate annotated source code for
all our files. It is generated automatically when `grunt` is running and can be found at
`/docs/app.html`.
# Deploy Process for Production
## Setup
### Setup Google App Engine Authentication file for deploy
```
#-- NOTE: the -n here is very important, a new line at the end of
# this file will prevent the grunt task from being able to parse
# this file
echo -n 'username@useallfive.com p455w0rd' > .gae.auth
```
### Setup to push to Google Code repo on production deploy
Add a .netrc to your home directory with the following contents:
```
machine code.google.com
login USERNAME@gmail.com.com
password [generated googlecode.com password]
```
To find out what your [generated googlecode.com password] should be, go to: https://code.google.com/a/google.com/hosting/settings
Prior to running the deploy command the person running the deploy will need to run:
`git remote add code.google.com https://code.google.com/a/google.com/p/gweb-artcopycode/`
## Push process
### Get latest development into master
1. Checkout development and pull latest changes `git checkout development; git pull -r`
2. Checkout master and pull latest changes `git checkout master; git pull -r`
3. Merge development into master `git merge --no-ff development`
* Note the `--no-ff`. This forces a merge commit, which is useful when inspecting the git log.
4. Push to master `git push origin master`
### Deploy
1. Install dependencies `npm install;bower install`
2. Deploy to production `grunt deploy:prod`
* This will ask you to select a version number. Use [semver](http://semver.org/) spec to make your decision.
### Get development up to date with master
Master will now be ahead of development because of the merge commit. Development should **always** be based off the latest verison of master.
1. Checkout development and rebase off of master `git checkout development; git rebase master`
2. Push development `git push origin development`
## Code Standards
### Sublime Settings
The JavaScript linting for this project requires [Sublime Text 3](http://www.sublimetext.com/3).
In Sublime Text 3 (ST3) install the following packages `CMD + Shift + P`:
- SublimeLinter
- SublimeLinter-jshint
- SublimeLinter-jscs
Next make sure you globally install the following on your command line:
- jshint `npm install -g jshint`
- jscs (JavaScript Code Style Checker) `npm -g install jscs`
### Resources
- Setup package control in ST3 - [Setup Package Control in ST3](https://sublime.wbond.net/installation)
- jscs documentation - [jscs github repo](https://github.com/mdevils/node-jscs)