README.md 2.14 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.
Merlin's avatar
Merlin committed
6
7
8

## openbabel
* `brew install cmake` for OSX
jwillem's avatar
jwillem committed
9
* install openbabel as described in its [documentation](https://github.com/cubuslab/openbabel/blob/master/INSTALL)
Merlin's avatar
Merlin committed
10
11
12
13
14
15
 
## rmagick
* `brew install imagemagick gs` for OSX
* if installing the rmagick gem fails you may try: `IM_PREFIX=$(brew list imagemagick 2>&1 | grep -E 'identify$' | sed 's/bin\/identify$//g') PKG_CONFIG_PATH=${IM_PREFIX}lib/pkgconfig/ C_INCLUDE_PATH=${IM_PREFIX}include/ImageMagick*/ gem install rmagick` (OSX only)

## Application Setup
Florian Hübsch's avatar
Florian Hübsch committed
16
17
18
* Execute `bundle install`.
* Execute `rake db:reset` (this creates and seeds the database).

19
20
# JS Setup & Testing

jwillem's avatar
jwillem committed
21
* Install `nvm`: `brew install nvm && echo "source $(brew --prefix nvm)/nvm.sh" >> ~/.profile`
jwillem's avatar
jwillem committed
22
23
* Copy `.nvmrc.example` to `.nvmrc`.
* Execute `nvm install` nvm will automatically use node 0.10.40 (in order to work with current jest-version)
24
25
* Execute `npm install`.

Florian Hübsch's avatar
Florian Hübsch committed
26
27
# Available Seeds

28
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).
29

30
31
32
33
# Mailing in Development Environment

Run `rake jobs:work` for asynchronous handling of email notifications. Run `mailcatcher` in your console and go to `localhost:1080` to see all sent mails.

34
35
36
37
# API (v1)

## Collections

38
* Get serialized, unshared collection roots for current user
39
40

  `/api/v1/collections/roots`
41

42
43
44
45
* Get serialized, shared collection roots for current user

  `/api/v1/collections/shared_roots`

46
47
48
* Get serialized samples by collection id

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

50
51
52
* Get serialized sample by id

  `/api/v1/samples/:id`
Jubke's avatar
Jubke committed
53
54
55
56
57
58
59
60
61
62
63
64

# 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`