https://github.com/miharekar/visualizer

A visualizer for .shot files
https://github.com/miharekar/visualizer

charts decent decentespresso espresso hotwire importmaps rails ruby visualizer

Last synced: 7 days ago
JSON representation

A visualizer for .shot files

• Host: GitHub
• URL: https://github.com/miharekar/visualizer
• Owner: miharekar
• License: mit
• Created: 2020-11-04T14:01:21.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:11:52.000Z (3 months ago)
• Last Synced: 2024-10-29T12:15:44.123Z (3 months ago)
• Topics: charts, decent, decentespresso, espresso, hotwire, importmaps, rails, ruby, visualizer
• Language: Ruby
• Homepage: https://visualizer.coffee/
• Size: 7.59 MB
• Stars: 96
• Watchers: 6
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Visualizer](https://visualizer.coffee/)

[![Visualizer Status](https://uptime.betterstack.com/status-badges/v3/monitor/wxvy.svg)](https://status.visualizer.coffee/)

![Ruby Tests](https://github.com/miharekar/visualizer/actions/workflows/main.yml/badge.svg)

Visualizer plays nice with [Decent espresso machines](https://decentespresso.com/), [Beanconqueror](https://beanconqueror.com/), [Gaggiuino](https://gaggiuino.github.io/), [Smart Espresso Profiler](https://www.naked-portafilter.com/product-category/smart-espresso-profiler/), [Pressensor](https://pressensor.com/), and many more devices. The list keeps growing.

Read all about it on [visualizer.coffee](https://visualizer.coffee/).

Application monitoring is sponsored by [AppSignal](https://appsignal.com/).

## Getting help

If you have questions, concerns, bug reports, etc., please open a new [GitHub Issue](https://github.com/miharekar/visualizer/issues/).

## 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](CONTRIBUTING.md) first 😊

## API

There is an API available. If something you would like is not there, please open a new [Issue](https://github.com/miharekar/visualizer/issues/) detailing your wishes.

You can read [the source code](/app/controllers/api) or [the API documentation](https://documenter.getpostman.com/view/2402164/UVC2HUik) provided by [@eriklenaerts](https://github.com/eriklenaerts).

Authenticatication is possible via [OAuth 2.0 authorization code flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/) 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](mailto:[email protected]).

## Dependencies

- Ruby (Check [.ruby-version](.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

  ```shell

  $ bundle install

  ```

- Setup database

  ```shell

  $ ./bin/rails db:setup

  ```

- Running the server

  ```shell

  $ ./bin/dev

  ```

- Running the tests

  ```shell

  $ ./bin/rails test

  ```

## Star History