Skip to content
This repository has been archived by the owner on May 26, 2021. It is now read-only.

joska/itk-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ITk API

API documentation

The documentation is maintained separately in Apiary.

Vagrant setup

For development, there is a vagrant box ready based on schotch/box. After running it, several steps are necessary to start the development.

Open MongoDB

MongoDB is closed for outside connections by default. Run

sudo nano /etc/mongod.conf

And then comment the line "bindIp: 127.0.0.1". After that, restart mongod service. After that, you should be able to acccess the ssh into vagrant machine and run the installation.

Installation

cd /var/www/itk.dev bundle install bundle exec ruby server.rb

Run

If installed correctly, you should be able to access the API on http://192.168.33.10:4567.

ToDo

  • finish endpoints
  • refactor into modules
  • refactor the app into multiple files
  • refactor errors
  • implement cache
  • write unit test
    • attachments
    • datetime and timezones
  • implement authorization and authentication
  • implement ACL
  • stress tests
  • logging

About

Sinatra API for ITk project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages