summaryrefslogtreecommitdiff
path: root/README.md
blob: 511e9cf31fa936fa7936d6d870bc278eb3f33269 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
opentox-server: Common part for OpenTox webservices
===================================================

Installation:
-------------

  gem install opentox-service

Development:
------------

  git clone git@github.com:<my-opentox-service>.git 
  cd <my-opentox-service>
  bundle install
  ./bin/toxbank-investigation-install # if not already installed, do not start webserver
  export RACK_ENV=development
  # if you are working on opentox-server|client gems as well edit Gemfile e.g.
  # gem 'opentox-server', :path => "~/opentox-server"
  # gem "opentox-client", :path => "~/opentox-client"
  # start webserver in development mode (runs at port 8080, should reload changes from source files)
  unicorn
  # open new terminal
  git flow init 
  git flow feature start <your feature>
  # code, test, code, ...
  git flow feature finish <your feature>
  # test
  # create release branch
  # increase version (in toxbank-investigation.gemspec)
  # install into system gems
  rake install
  # test
  # create master
  # release
  rake release


Documentation
-------------
* [API documentation](http://opentox.org/dev/api)
* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-server/development/frames)