3.4 KiB
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): <<<<<<< HEAD
- 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
letinstead ofvar: SA Post
Testing
We're using Facebook's jest to do testing as it integrates nicely with react.js as well.
Tests are always created per directory by creating a __tests__ folder. To test a specific file, a <file_name>_tests.js file needs to be created.
Since we're using mixed syntax, test files are not linted using ES6Lint. This is due to the fact that jest's function mocking and ES6 module syntax are fundamentally incompatible.
Therefore, to require a module in your test file, you need to use CommonJS's require syntax. Except for this, all tests can be written in ES6 syntax.
Workflow
Generally, when you're runing gulp serve, all tests are being run.
If you want to test exclusively (without having the obnoxious ES6Linter warnings), you can just run gulp jest:watch.
Troubleshooting
Q: OMG nothing works
A: try npm install. Someone may have updated some dependencies