onion/README.md

Introduction
============

Onion is the web client for Ascribe. The idea is to have a well documented,
easy to test, easy to hack, JavaScript application.

The code is JavaScript ECMA 6.


Getting started
===============
Install some nice extensions for Chrom(e|ium):
- [Allow-Control-Allow-Origin](https://chrome.google.com/webstore/detail/allow-control-allow-origi/nlfbmbojpeacfghkpbjhddihlkkiljbi):
  we need this to open connection to external hosts ([staging.ascribe.io](http://staging.ascribe.io/) in our case)
- [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi)
  
```bash
git clone git@bitbucket.org:ascribe/onion.git
cd onion
npm install
gulp serve
```


Code Conventions
================
For this project, we're using:

* 4 Spaces
* We use ES6
* We don't use ES6's class declaration for React components because it does not support Mixins as well as Autobinding ([Blog post about it](http://facebook.github.io/react/blog/2015/01/27/react-v0.13.0-beta-1.html#autobinding))
* We don't use camel case for file naming but in everything Javascript related
* We use `let` instead of `var`: [SA Post](http://stackoverflow.com/questions/762011/javascript-let-keyword-vs-var-keyword) 


Troubleshooting
===============

Q: OMG nothing works
A: try `npm install`. Someone may have updated some dependencies


Reading list
============

Start here
----------

- [ReactJS for stupid people](http://blog.andrewray.me/reactjs-for-stupid-people/)
- [Flux for stupid people](http://blog.andrewray.me/flux-for-stupid-people/)
- [ReactJS](https://facebook.github.io/react/)
- [alt.js](http://alt.js.org/)
- [alt.js readme](https://github.com/goatslacker/alt)


Moar stuff
----------

- [ReactJS: Reusable Components](https://facebook.github.io/react/docs/reusable-components.html#es6-classes)
- [24ways.org: JavaScript Modules the ES6 Way](http://24ways.org/2014/javascript-modules-the-es6-way/)
- [Babel: Learn ES6](https://babeljs.io/docs/learn-es6/)
- [egghead's awesome reactjs and flux tutorials](https://egghead.io/)
- [Crockford's genious Javascript: The Good Parts (Tim has a copy)](http://www.amazon.de/JavaScript-Parts-Working-Shallow-Grain/dp/0596517742)
First commit! Work on README 2015-05-12 14:59:58 +02:00			`Introduction`
			`============`

			`Onion is the web client for Ascribe. The idea is to have a well documented,`
Ehm, some changes lol 2015-05-13 15:42:55 +02:00			`easy to test, easy to hack, JavaScript application.`
First commit! Work on README 2015-05-12 14:59:58 +02:00
Add link to reading list 2015-05-13 14:44:44 +02:00			`The code is JavaScript ECMA 6.`

First commit! Work on README 2015-05-12 14:59:58 +02:00
			`Getting started`
			`===============`
Update readme 2015-05-26 11:12:17 +02:00			`Install some nice extensions for Chrom(e\|ium):`
			`- [Allow-Control-Allow-Origin](https://chrome.google.com/webstore/detail/allow-control-allow-origi/nlfbmbojpeacfghkpbjhddihlkkiljbi):`
			`we need this to open connection to external hosts ([staging.ascribe.io](http://staging.ascribe.io/) in our case)`
			`- [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi)`

Add package.json 2015-05-12 15:28:59 +02:00			```bash
			`git clone git@bitbucket.org:ascribe/onion.git`
			`cd onion`
			`npm install`
remove npm start scripts, add gulp for build and watch, add source maps 2015-05-26 19:16:30 +02:00			`gulp serve`
Add package.json 2015-05-12 15:28:59 +02:00			```

Update readme 2015-05-26 11:12:17 +02:00

Fix autobinding bug, considering the components creation 2015-05-19 11:23:49 +02:00			`Code Conventions`
Update README.md 2015-05-26 10:52:30 +02:00			`================`
Fix autobinding bug, considering the components creation 2015-05-19 11:23:49 +02:00			`For this project, we're using:`

			`* 4 Spaces`
			`* We use ES6`
Remove superagent, add isomorphic fetch instead again, add constants as well as utility functions 2015-05-19 13:45:19 +02:00			`* We don't use ES6's class declaration for React components because it does not support Mixins as well as Autobinding ([Blog post about it](http://facebook.github.io/react/blog/2015/01/27/react-v0.13.0-beta-1.html#autobinding))`
			`* We don't use camel case for file naming but in everything Javascript related`
refactor: use let instead of var 2015-05-19 17:16:01 +02:00			* We use `let` instead of `var`: [SA Post](http://stackoverflow.com/questions/762011/javascript-let-keyword-vs-var-keyword)
Add package.json 2015-05-12 15:28:59 +02:00

Update README.md 2015-05-26 10:52:30 +02:00			`Troubleshooting`
			`===============`

			`Q: OMG nothing works`
			A: try `npm install`. Someone may have updated some dependencies


Add package.json 2015-05-12 15:28:59 +02:00			`Reading list`
			`============`
Add new links to README 2015-05-21 10:46:22 +02:00
			`Start here`
			`----------`

			`- [ReactJS for stupid people](http://blog.andrewray.me/reactjs-for-stupid-people/)`
			`- [Flux for stupid people](http://blog.andrewray.me/flux-for-stupid-people/)`
			`- [ReactJS](https://facebook.github.io/react/)`
Add package.json 2015-05-12 15:28:59 +02:00			`- [alt.js](http://alt.js.org/)`
Add link to reading list 2015-05-13 14:44:44 +02:00			`- [alt.js readme](https://github.com/goatslacker/alt)`
Add new links to README 2015-05-21 10:46:22 +02:00

			`Moar stuff`
			`----------`

			`- [ReactJS: Reusable Components](https://facebook.github.io/react/docs/reusable-components.html#es6-classes)`
README.md edited online with Bitbucket 2015-05-20 21:21:33 +02:00			`- [24ways.org: JavaScript Modules the ES6 Way](http://24ways.org/2014/javascript-modules-the-es6-way/)`
			`- [Babel: Learn ES6](https://babeljs.io/docs/learn-es6/)`
README.md edited online with Bitbucket 2015-05-20 21:39:47 +02:00			`- [egghead's awesome reactjs and flux tutorials](https://egghead.io/)`
Add new links to README 2015-05-21 10:46:22 +02:00			`- [Crockford's genious Javascript: The Good Parts (Tim has a copy)](http://www.amazon.de/JavaScript-Parts-Working-Shallow-Grain/dp/0596517742)`