README.md 1.21 KB
Newer Older
1
# Basic Setup
Florian Hübsch's avatar
Florian Hübsch committed
2
3
4
5
6
7
8
* 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.
* Execute `bundle install`.
* Execute `rake db:reset` (this creates and seeds the database).

9
10
# JS Setup & Testing

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

Florian Hübsch's avatar
Florian Hübsch committed
17
18
# Available Seeds

19
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).
20
21
22
23
24

# API (v1)

## Collections

25
* Get serialized, unshared collection roots for current user
26
27

  `/api/v1/collections/roots`
28

29
30
31
32
* Get serialized, shared collection roots for current user

  `/api/v1/collections/shared_roots`

33
34
35
* Get serialized samples by collection id

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

37
38
39
* Get serialized sample by id

  `/api/v1/samples/:id`