https://github.com/flet/mixcoffee
:coffee: Dashboard and API for tracking coffee fund via google spreadsheet
https://github.com/flet/mixcoffee
Last synced: 2 months ago
JSON representation
:coffee: Dashboard and API for tracking coffee fund via google spreadsheet
- Host: GitHub
- URL: https://github.com/flet/mixcoffee
- Owner: Flet
- License: isc
- Created: 2016-09-06T17:37:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-13T18:59:42.000Z (almost 8 years ago)
- Last Synced: 2025-02-17T20:40:09.231Z (4 months ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# mixcoffee
Dashboard and API for our friendly neighborhood coffee fund.
## Install
```
npm Install
```
## Usage
- the app expects the environment variable **GOOGLE_SPREADSHEET_ID**, which should be the ID of publishd Spreadsheet
- generate this id by going to **File** > **Publish to the web...**
- the ID will be part of the URL shown:
- https://docs.google.com/spreadsheets/d/**id-will-be-here**/pubhtml
```bash
# specify the env var at startup
GOOGLE_SPREADSHEEET_ID=my-spreadsheet-id npm start
```
Once the app is up and running, just add values to the spreadsheet via Google Docs and they will be pulled in automatically!
## Google Spreadsheet format
The app expects these columns:
| Day | Contributor | Amount | Comment | image | Balance |
| --------- | ----------- | ------- | --------------------------------------------- | ---------------------------------------- | ------- |
| 1/4/2016 | Dan | $10.00 | | | $10.00 |
| 1/5/2016 | Steve | $10.00 | | | $20.00 |
| 1/5/2016 | COFFEE | -$17.50 | Greenway Gedeb Chelbessa Yirgacheffe Ethiopia | | $3.50 |
| 1/8/2016 | COFFEE | -$17.50 | Crema - Finca Dragon Red Honey Costa Rica | http://example.com/some-coffee-image.jpg | -$14.00 |
| 1/8/2016 | Flet | $10.00 | | | -$4.00 |
- entries should be in chronological order with the most recent at the bottom
- Contributor names should be consistent so they can be rolled up
- to record new coffee, contributor should be COFFEE and amount should be a negative value
- the Balance value should be the total of all previous fields so the bottom row's balance reflects the current balance
## Deploying
### Deploying to Glitch
[glitch.com](https://glitch.com) is a great place to host an instance of this project.
Here are the steps:
- Create a new project
- Click the project name in the top left and choose Advanced Options
- Click "Grant access to import and export to a repo" and go through the steps to link your GitHub account
- Once thats done, click the "Import from Github" button
- In the text prompt, type **Flet/mixcoffee**
- Once the project is imported, click on the **env** file on the left
- Add this entry:
```bash
GOOGLE_SPREADSHEET_ID=put-your-spreadsheet-id-here
```
- Thats it! Click "Show Live" to visit the site
To update to the latest code version, just re-import the same project again. The `env` file will be retained between imports, so there is no need to update it again.
### Deploying to Now
This project has built in scripts for [now.sh](https://zeit.co/now) deployment. The deploy script assumes there is a `now secret` called `@coffee-spreadsheet-url`.
Run these commands one time to setup the secret:
```bash
now secrets add coffee-spreadsheet-id "my-coffee-spreadsheet-id"
```
Now that the secret is set, we can run the `package.json` script to redeploy
```bash
npm run deploy
```
Once the deploy is done and looks good, update the `now alias` to update production:
```bash
now alias set https://mixcoffee-qwertyuiop.now.sh coffeefund.now.sh
```
## License
[ISC](LICENSE)