Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakofranko/tilt-server

Webserver for ingesting Tilt Hydrometer data
https://github.com/jakofranko/tilt-server

Last synced: 12 days ago
JSON representation

Webserver for ingesting Tilt Hydrometer data

Awesome Lists containing this project

README

        

## Installation

This web application requires Node.js to run (latest stable version).

After cloning this repo to your local machine run

`npm install`

After all the dependencies are installed, run

`npm start`

## Usage

Figure out the IP address of the machine that you intend to run the tilt-server upon. Once you know this IP address, then input `:3000/tilt-data` as the URL within the Tilt app. The Tilt app should then start sending post requests to the web server, and you should see the headers and request body logging to the console.

Making a GET request to `:3000/tilt-data` should return an array of all beer data.

Making POST requests to the tilt-data endpoint will save the data to the tilt_data table. It must have this format:

```typescript
type TiltEvent = {
"Beer": string,
"Temp": number,
"SG": number,
"Color": string,
"Comment": string,
"Timepoint": number
}
```

Navigating to `:3000/beers` will present a list of your beers by name. Clicking on a beer will take you to a graph of their tilt data.

Navigating to `:3000/upload` will allow you to upload a CSV of Tilt data, which will get imported into the SQLite DB.

## TODOs

- decide what data to show on the graph, and how best to do it
- clean up DB queries to all be in the db file, or maybe even refactor into a models architecture (a la https://stackabuse.com/a-sqlite-tutorial-with-node-js/ perhaps)
- elementary CRUD functionality to allow for deleting anomalous data entries