Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alfg/opendrinks

:cocktail: Open Source Drinks! Add your own recipe in a pull request! Inspired by 🎃Hacktoberfest!
https://github.com/alfg/opendrinks

cocktails drinks hacktoberfest hacktoberfest2021 javascript js node recipes vue

Last synced: about 14 hours ago
JSON representation

:cocktail: Open Source Drinks! Add your own recipe in a pull request! Inspired by 🎃Hacktoberfest!

Awesome Lists containing this project

README

        

# 🍸 Open Drinks

> Open source drinks! Inspired by [🎃Hacktoberfest](https://hacktoberfest.digitalocean.com/)!

https://opendrinks.io/

[![Netlify Status](https://api.netlify.com/api/v1/badges/942bef4f-2873-4e49-91c6-c92373a4473e/deploy-status)](https://opendrinks.netlify.com)
[![Build Status](https://travis-ci.org/alfg/opendrinks.svg?branch=master)](https://travis-ci.org/alfg/opendrinks)
[![Node CI](https://github.com/alfg/opendrinks/workflows/Node%20CI/badge.svg)](https://github.com/alfg/opendrinks/actions)

**OpenDrinks** is powered and hosted by [Netlify](https://www.netlify.com)!



## Submit a drink recipe

Looking to submit a drink recipe? Check out the Contributing Guidelines first!

See: [CONTRIBUTING.md](CONTRIBUTING.md)

- Check existing recipes in [/src/recipes](/src/recipes)
- Fork and make a pull request with your drink recipe
- Once your Pull Request is approved and merged, the latest update will be published to https://opendrinks.io

Also check out [Issues](https://github.com/alfg/opendrinks/issues) for any open bug fixes or feature requests!

## Development

Open Drinks is built with the following technologies:

- [Vue](https://vuejs.org/)
- [BootstrapVue](https://bootstrap-vue.js.org/)
- Hosted on [Netlify](https://www.netlify.com/) with [automated deployments](https://www.netlify.com/docs/continuous-deployment/)!

If you are familiar or want to give it a shot, feel free to contribute!

### Prerequisites

- Install version 14+ of Node.js on your machine
- There is [nvm](https://github.com/nvm-sh/nvm) support. If you have nvm installed the following commands will install and start using version 14.16.0

```
nvm install
nvm use
```

### Install

```
npm install
npm run serve
```

### Compiles and minifies for production

```
npm run build
```

### Lint

```
npm run lint
```

### Test

```
npm test
```

### Docker

```
docker build -t opendrinks .
docker run -it -p 8080:80 --rm opendrinks
```

## License

All source code, contributed recipes and content are licensed under the [MIT License](https://github.com/alfg/opendrinks/blob/master/LICENSE).