README
¶
cold-brew
Cold Brew is a project to control a kyoto cold brew tower via software.
Project Status
This was originally a successful hackweek project at my current place of employment. I am currently in the process of refactoring code and gathering a group of resources (documentation, release pipelines, wiring diagrams, etc) so that others can build their own electronic cold brew towers.
Frontend Development
# install dependencies
npm install
# serve with hot reload at localhost:3000
npm run dev
Backend Development
# run server
make run
The mocks for unit testing were generated using mock:
# generate mocks
make mocks
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides a shared data model for the application and potential clients.
|
Package api provides a shared data model for the application and potential clients. |
|
cmd
|
|
|
cold-brew-server
Cold Brew is a project to control a kyoto cold brew tower via software.
|
Cold Brew is a project to control a kyoto cold brew tower via software. |
|
internal
|
|
|
server
Package server provides a RESTful HTTP interface for the cold brew coffee dripper.
|
Package server provides a RESTful HTTP interface for the cold brew coffee dripper. |
|
pkg
|
|
|
dripper
Package dripper provides an interface to interact with the underlying cold brew dripper hardware.
|
Package dripper provides an interface to interact with the underlying cold brew dripper hardware. |
|
dripper/mock_dripper
Package mock_dripper is a generated GoMock package.
|
Package mock_dripper is a generated GoMock package. |
Click to show internal directories.
Click to hide internal directories.