https://github.com/alisdair/trackchair-client

REST API client for TrackChair https://www.trackchair.com/
https://github.com/alisdair/trackchair-client

Last synced: 10 days ago
JSON representation

REST API client for TrackChair https://www.trackchair.com/

• Host: GitHub
• URL: https://github.com/alisdair/trackchair-client
• Owner: alisdair
• License: other
• Created: 2014-06-08T15:56:31.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-21T11:31:50.000Z (over 9 years ago)
• Last Synced: 2024-10-12T20:57:04.723Z (24 days ago)
• Language: Ruby
• Size: 145 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# TrackChair API Client

REST API client for [TrackChair][trackchair].

[trackchair]: https://www.trackchair.com/

## Usage

Requires Ruby 2.0 and bundler (`gem install bundler`).

Basics:

    git clone https://github.com/alisdair/trackchair-client.git

    cd trackchair-client

    bundle install

First, log in to the API to create an access token by running `bundle exec ruby bin/trackchair-login`.

This will ask for your email and password, and store an API token in `~/.trackchair-client`. Note: the token will expire after 2 weeks of inactivity.

There are two example utilities provided with the package: `trackchair-papers`, and `trackchair-program-entry`. Use these as templates to build your own programs.

## API documentation

Coming soon? Here are the Rails routes in case you feel like experimenting:

```ruby

# API

namespace :api do

  resources :tokens, only: [:create]

  resources :tracks, only: [:index]

  resources :accounts, only: [:index, :show, :update]

  resources :papers, only: [:index, :show] do

    get :manuscript, on: :member

    resources :tags, only: [:index]

    resources :comments, only: [:index, :create, :destroy]

  end

end

```

## License

MIT.