Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/butlerx/invbeertory

Inventory display for beer stock
https://github.com/butlerx/invbeertory

Last synced: 3 months ago
JSON representation

Inventory display for beer stock

Host: GitHub
URL: https://github.com/butlerx/invbeertory
Owner: butlerx
License: mit
Created: 2019-11-23T13:32:46.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-03-14T23:23:31.000Z (almost 2 years ago)
Last Synced: 2024-04-26T18:06:32.210Z (8 months ago)
Language: TypeScript
Homepage: https://beer.notthe.cloud
Size: 4.03 MB
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Welcome to invbeertory 👋

![Version](https://img.shields.io/badge/version-0.1.0-blue.svg?cacheSeconds=2592000)

[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/butlerx/invbeertory#readme)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/butlerx/invbeertory/graphs/commit-activity)

[![License: MIT](https://img.shields.io/github/license/butlerx/invbeertory)](https://github.com/butlerx/invbeertory/blob/master/LICENSE)

[![Twitter: cianbutlerx](https://img.shields.io/twitter/follow/cianbutlerx.svg?style=social)](https://twitter.com/cianbutlerx)

[![Netlify Status](https://api.netlify.com/api/v1/badges/b8e09816-1468-4e09-854c-cdbd0fb7107d/deploy-status)](https://app.netlify.com/sites/affectionate-snyder-2e9cae/deploys)

> Simple beer inventory displaty

### ✨ [Demo](beer.notthe.cloud)

## Install

```sh

yarn

```

## Usage

Before building you will need to add credentials to the `.env` file or set them

in the shell env. see `.env.sample` or below

```sh

PROJECT_ID=""

SPREADSHEET_ID=""

CLIENT_EMAIL=""

PRIVATE_KEY_ID=""

PRIVATE_KEY=""

```

You can get the `SPREADSHEET_ID` from the URL of your sheet,

`https://docs.google.com/spreadsheets/d//edit#gid=12345`. You

will have to create a service account which will provide you with the service

account email id and a private key. To know more about creating service account

you can visit [here](https://support.google.com/a/answer/7378726?hl=en) and read

[this](https://www.twilio.com/blog/2017/03/google-spreadsheets-and-javascriptnode-js.html).

After creating a service account share your sheet with edit permission with the

given email id.

```sh

yarn build

```

## Author

👤 **Cian Butler **

- Website: [cianbutler.ie](https://cianbutler.ie)

- Twitter: [@cianbutlerx](https://twitter.com/cianbutlerx)

- Github: [@butlerx](https://github.com/butlerx)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/butlerx/invbeertory/issues).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2019

[Cian Butler ](https://github.com/butlerx).

This project is

[MIT](https://github.com/butlerx/invbeertory/blob/master/LICENSE) licensed.

---