onion/README.md

33 lines
722 B
Markdown
Raw Normal View History

2015-05-12 14:59:58 +02:00
Introduction
============
Onion is the web client for Ascribe. The idea is to have a well documented,
2015-05-13 15:42:55 +02:00
easy to test, easy to hack, JavaScript application.
2015-05-12 14:59:58 +02:00
2015-05-13 14:44:44 +02:00
The code is JavaScript ECMA 6.
2015-05-12 14:59:58 +02:00
Getting started
===============
2015-05-12 15:28:59 +02:00
```bash
git clone git@bitbucket.org:ascribe/onion.git
cd onion
npm install
2015-05-15 15:05:17 +02:00
npm run watch
2015-05-12 15:28:59 +02:00
```
Code Conventions
============
For this project, we're using:
* 4 Spaces
* We use ES6
* We don't use ES6's class declaration 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))
2015-05-12 15:28:59 +02:00
Reading list
============
- [alt.js](http://alt.js.org/)
2015-05-13 14:44:44 +02:00
- [alt.js readme](https://github.com/goatslacker/alt)