Skip to content

miharekar/visualizer

Repository files navigation

Visualizer Status

Ruby Tests

Visualizer plays nice with Decent espresso machines, Beanconqueror, Gaggiuino, Smart Espresso Profiler, Pressensor, and many more devices. The list keeps growing.

Read all about it on visualizer.coffee.

Application monitoring is sponsored by AppSignal.

Getting help

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

Getting involved

If you love coffee, want to learn Ruby, or want to help in whatever way you can, you're more than welcome to get involved!

Please read the Contribution Guidelines first 😊

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 (>= 14)

No other services are required though Cloudinary and S3 are expected in config/storage.yml. Feel free to override them for development purposes.

Setup

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

Star History

Star History Chart