Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.42 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.42 KB
Raw

Decent Visualizer

Ruby Tests

A visualizer for .shot files created by the Decent Espresso Machine.

Visualizer is a relatively standard Ruby on Rails application with a Postgres database.

Read all about the v2 version, and feel free to join Visualizer Forum.

API

There is an API available. If something you would like is not there, please open a new Issue detailing your wishes.

You can read the source code or the API documentation provided by @eriklenaerts.

Authenticatication is possible via OAuth 2.0 authorization code flow with read, upload, and write scopes. The difference between upload and write is that upload is only for uploading shots, and write is for everything. This enables you to have a "low danger" scope, so that even if a token is stolen, the worst that can happen is that the attacker can upload shots. But they won't be able to delete them. All endpoints return JSON.

If you want to create OAuth applications please contact me.

Dependencies

  • Ruby (Check .ruby-version for specific version)
    • Bundler (gem install bundler)
  • Postgres (>= 12)
  • Redis (>= 6)

Setup

  • Install Ruby gems 
    $ bundle install
  • Setup database 
    $ ./bin/rails db:setup
  • Running the server 
    $ ./bin/dev
  • Running the tests 
    $ ./bin/rails test

Getting help

If you have questions, concerns, bug reports, etc., please open a new GitHub Issue.

Getting involved

If you're a coffee fanatic, own a Decent Espresso machine, want to learn Ruby, or want to help in whatever way you can, you're more than welcome to get involved!

But please read the Contribution Guidelines first 😊