mirror of
https://github.com/ascribe/onion.git
synced 2024-12-22 09:23:13 +01:00
Onion is the web client for ascribe
fonts | ||
js | ||
sass | ||
.eslintrc | ||
.gitignore | ||
gulpfile.js | ||
index.html | ||
package.json | ||
README.md | ||
server.js |
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: we need this to open connection to external hosts (staging.ascribe.io in our case). Please note that there is an open issue that prevents the extension to save the changes in the "intercepted URL or URL pattern". You can follow this workaround to fix the problem.
- React Developer Tools
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)
- We don't use camel case for file naming but in everything Javascript related
- We use
let
instead ofvar
: SA Post
Troubleshooting
Q: OMG nothing works
A: try npm install
. Someone may have updated some dependencies