vegancheck.me/README.md

53 lines
2.9 KiB
Markdown
Raw Normal View History

2021-08-24 10:45:58 +00:00
<p align="center">
2021-08-26 11:10:27 +00:00
<img width="100px" src="img/VeganCheck.svg" align="center" alt="VeganCheck Logo">
2021-08-24 10:45:58 +00:00
<h1 align="center">VeganCheck.me</h1>
2021-08-24 10:52:41 +00:00
<p align="center">Check if a product is vegan or not with <a href="https://vegancheck.me">VeganCheck.me</a></p>
2021-08-24 10:45:58 +00:00
</p>
<p align="center">
2021-08-24 10:52:41 +00:00
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fphilipbrembeck%2Fvegancheck.me?ref=badge_small" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fphilipbrembeck%2Fvegancheck.me.svg?type=small"></a>
2021-08-30 11:36:33 +00:00
<a href="https://jokenetwork.de/badges"><img alt="JKN Status: Active" src="https://jokenetwork.de/assets/img/gitstatus/active.svg"></a>
2021-08-24 10:52:41 +00:00
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fphilipbrembeck%2Fvegancheck.me?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fphilipbrembeck%2Fvegancheck.me.svg?type=shield"></a>
<a href="https://www.codacy.com/gh/philipbrembeck/vegancheck.me/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=philipbrembeck/vegancheck.me&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/181208ec1e6644e0bdc7a8b3271e3708"/></a>
2021-08-30 11:36:11 +00:00
<a href="https://codeclimate.com/github/JokeNetwork/vegancheck.me/maintainability"><img src="https://api.codeclimate.com/v1/badges/3e4c87c9f6b92b9e13b5/maintainability" /></a>
2021-08-24 10:45:58 +00:00
<a href="https://github.com/sponsors/philipbrembeck"><img src="https://img.shields.io/badge/Sponsor-white.svg?logo=githubsponsors" alt="Consider Sponsoring"></a>
<a href="https://www.paypal.com/donate?hosted_button_id=N4F7DAQH7ET2G"><img src="https://img.shields.io/badge/Donate-blue.svg?logo=paypal" alt="Donate"></a>
</p>
2021-08-24 10:52:41 +00:00
VeganCheck.me checks the EAN or UPC-Code of a product and simply tells you if it's vegan or not.
2021-08-24 10:45:58 +00:00
2021-08-24 10:52:41 +00:00
VeganCheck.me is meant as an useful tool for vegans and vegetarians - Developed with usability in mind.
2021-08-30 10:29:13 +00:00
[See it in action](https://vegancheck.me) | [Product page on JokeNetwork.de](https://jokenetwork.de/#projects)
2021-08-24 10:45:58 +00:00
2021-08-24 15:04:04 +00:00
## 👨🏼‍💻 Overview
2021-08-24 10:45:58 +00:00
2021-08-26 11:10:27 +00:00
![VeganCheck.me Screenshot](img/Hero.svg)
2021-08-26 11:13:32 +00:00
<p align="center">
<img src="img/demo.gif" alt="VeganCheck.me Demo" align="center" height="500">
</p>
2021-08-24 10:45:58 +00:00
2021-08-24 15:04:04 +00:00
## ☑️ ToDo
2021-08-24 10:45:58 +00:00
Integrate:
2021-08-26 09:15:54 +00:00
* [x] Open-source JavaScript-based scanner (Works on mobile only)
2021-08-24 15:04:04 +00:00
* [ ] Text search
* [ ] Options for vegetarians
* [ ] Sustainability assessment
* [x] Nutri-Score integration (Currently testing)
2021-08-24 10:45:58 +00:00
2021-08-24 15:04:04 +00:00
## 🤝 Credits
2021-08-24 10:45:58 +00:00
2021-08-24 11:00:21 +00:00
This repo will be further maintained by [@jokenetwork](https://github.com/jokenetwork) ([JokeNetwork.de](https://jokenetwork.de))
2021-08-24 10:45:58 +00:00
This repo uses:
2021-08-24 10:57:30 +00:00
* [JQuery](https://jquery.com)
* [OpenFoodFacts API](https://openfoodfacts.org)
2021-08-26 09:15:54 +00:00
* [BarCode-reader](https://github.com/iemadk/BarCode-reader) by [Emad Kamal](https://github.com/iemadk)
2021-08-24 10:45:58 +00:00
2021-08-24 15:04:04 +00:00
## 👩‍⚖️ License
2021-08-24 10:45:58 +00:00
All text and code in this repository is licensed under [MIT](https://github.com/philipbrembeck/VeganCheck.me/blob/main/LICENSE).