README.md 1.63 KB
Newer Older
1
# Basic Setup
Florian Hübsch's avatar
Florian Hübsch committed
2
3
4
5
* Copy `config/database.yml.example` to `config/database.yml` and enter your database connection information.
* Copy `.ruby-gemset.example` to `.ruby-gemset`.
* Copy `.ruby-version.example` to `.ruby-version`.
* Reload directory to create rvm gemset.
jwillem's avatar
jwillem committed
6
7
* `brew install cmake` for Mac OS X
* install openbabel as described in its [documentation](https://github.com/cubuslab/openbabel/blob/master/INSTALL)
Florian Hübsch's avatar
Florian Hübsch committed
8
9
10
* Execute `bundle install`.
* Execute `rake db:reset` (this creates and seeds the database).

11
12
# JS Setup & Testing

jwillem's avatar
jwillem committed
13
* Install `nvm`: `brew install nvm && echo "source $(brew --prefix nvm)/nvm.sh" >> ~/.profile`
jwillem's avatar
jwillem committed
14
15
* Copy `.nvmrc.example` to `.nvmrc`.
* Execute `nvm install` nvm will automatically use node 0.10.40 (in order to work with current jest-version)
16
17
18
* Execute `npm install`.
* Execute `npm test`.

Florian Hübsch's avatar
Florian Hübsch committed
19
20
# Available Seeds

21
Currently 3 users are seeded with respective email `test@ninjaconcept.com`, `hattori@ninjaconcept.com`, `momochi@ninjaconcept.com`, and password `ninjaconcept` (for all 3 the same).
22
23
24
25
26

# API (v1)

## Collections

27
* Get serialized, unshared collection roots for current user
28
29

  `/api/v1/collections/roots`
30

31
32
33
34
* Get serialized, shared collection roots for current user

  `/api/v1/collections/shared_roots`

35
36
37
* Get serialized samples by collection id

  `/api/v1/collections/:collection_id/samples`
38

39
40
41
* Get serialized sample by id

  `/api/v1/samples/:id`
Jubke's avatar
Jubke committed
42
43
44
45
46
47
48
49
50
51
52
53

# Icon Font

* put new icons as SVG files (e.g. '<ICON_NAME>.svg') in `app/assets/images/svg_icons`
* run `rake icons:compile`

Icons are now available as css classes: '.icon-<ICON_NAME'

## FontCustom Dependencies

* `brew install fontforge --with-python`
* `brew install eot-utils`