A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Veganify

A multilingual progressive web app, which scans the EAN or UPC codes of over 3.000.000 food- or non-food-products and simply tells you if it they're vegan or not.
https://github.com/frontendnetwork/veganify

Category: Consumption
Sub Category: Agriculture and Nutrition

Keywords

barcode barcode-scanner html5 javascript nextjs nodejs nutriscore nutrition nutrition-information nutrition-services openbeautyfacts openfoodfacts progressive-web-app pwa react scanner vegan vegan-dishes vegan-ingredients

Keywords from Contributors

transformer animations nonprofit hacking stress-test projects convolutional-neural-networks measuring simulator reporting

Last synced: about 1 hour ago
JSON representation

Repository metadata

Veganify is a modern webapp that allows you to easily scan EAN barcodes to check if a product is vegan-friendly. With a database of over 3 million products, you can quickly find out if your favorite foods and products are suitable for a vegan diet.

README.md

Veganify

Check if a product is vegan or not with » Veganify.app

Overview

Veganify checks the barcode (EAN or UPC) of a food- or non-food-product and tells you if it is vegan or not. It is an useful tool for vegans and vegetarians - Developed with usability and simplicity in mind, so without distracting irrelevant facts or advertising.
Veganify combines the Databases of OpenFoodFacts, OpenBeautyFacts and Open EAN Database, as well as our very own ingredient checker in one tool.

The Veganify Ingredients API checks the products ingredients against a list of thousands of non-vegan items.

Developer Guide

[!TIP]
We're using Conventional Commits for commit messages. Please follow this convention when making changes.

Prerequisites

  • Node.js 20 or later
  • pnpm (enabled via corepack)

To enable pnpm using corepack:

corepack enable
corepack prepare pnpm@latest --activate

Getting Started

  1. Clone the repository:

    git clone https://github.com/frontendnetwork/veganify.git
    cd veganify
    
  2. Install dependencies & start dev server:

    pnpm install
    pnpm dev
    

Project Structure

src/
├── @components/
│   ├── shared/
│   ├── ComponentName/
│   │   ├── hooks/      			# Component-specific hooks
│   │   ├── utils/      			# Component-specific utilities
│   │   │	├── util.ts
│   │   │	└──	util.test.ts		# Utility specify tests
│   │   ├── models/     			# Component-specific types/interfaces
│   │   ├── componentPart.tsx		# Component files
│   │   └── index.tsx				# Component files
├── @models/        # Global type definitions
├── styles/         # CSS styles
├── tests/          # Only test setup files & Playwright tests
└── locales/        # next-intl translation files

Development Commands

# Start development server
pnpm dev

# Run linting
pnpm lint

# Run type checking
pnpm check-types

# Run unit tests
pnpm test

# Run end-to-end tests
pnpm test:e2e

# Build for production
pnpm build

Development Guidelines

[!NOTE]
We're aware not everything in this repo follows those standards. This is because of how the project was started and evolved. We're working on improving this.

Component Structure

  • Break down components into smaller, reusable pieces
  • Each significant component should have its own directory with the following structure:
    • hooks/ for component-specific hooks
    • utils/ for component-specific utilities
    • models/ for component-specific types
  • Small, simple components can be single files

Testing

  • All utility functions must have 100% test coverage
  • Tests are written using Jest for unit testing
  • Components currently don't require test coverage
  • Playwright is used for end-to-end testing but currently only coversa few basics use cases. More tests are needed.

TypeScript

  • TypeScript is mandatory
  • The any type is not acceptable unless absolutely necessary
  • Always define proper interfaces and types in the appropriate models folder
  • Use type inference when possible

Internationalization

  • Use next-intl for translations
  • Add new translations to all language files in /locales
  • Follow the existing translation key structure

Code Style

  • Follow Node.js, React, and Next.js best practices
  • Use the App Router pattern for routing
  • Keep components pure and functional when possible
  • Use hooks for state management and side effects
  • Follow the DRY (Don't Repeat Yourself) principle
  • Use meaningful variable and function names
  • Write comments for complex logic
  • Keep functions small and focused

Styling

  • Place all styles in the styles folder
  • Keep styles modular and scoped to components when possible
  • Be sure to use SCSS for styling
  • Use CSS variables for theming and repeated values

When making a contribution, please follow these guidelines to ensure consistency and maintainability.

Remember that every contribution, no matter how small, is valuable to the project. Thank you for helping make Veganify better!

Support

Please refer to our issue trackers to see where you could help:

or if you find something else you could improve, just open a new issue for it!

Support us



Premium Supporters

Dependencies & Credits

This repo uses:

License

All text and code in this repository is licensed under MIT, © 2024 Philip Brembeck, © 2024 FrontEndNetwork.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 1,386
Total Committers: 16
Avg Commits per committer: 86.625
Development Distribution Score (DDS): 0.226

Commits in past year: 153
Committers in past year: 2
Avg Commits per committer in past year: 76.5
Development Distribution Score (DDS) in past year: 0.373

Name Email Commits
Philip 4****k 1073
dependabot[bot] 4****] 264
Philip 8****r 10
ImgBotApp I****p@g****m 6
DeepSource Bot b****t@d****o 5
snyk-bot s****t@s****o 5
Frank Schneidewind f****d@m****e 5
Michal Bryxí m****i@g****m 3
deepsource-autofix[bot] 6****] 3
imgbot[bot] 3****] 3
Łukasz Wójcik 1****k 3
JokeNetwork Bot 8****t 2
Can Karatepe c****0@g****m 1
Nils Jacobsen n****8@g****m 1
codefactor-io s****t@c****o 1
fastrcloud g****b@c****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 13
Total pull requests: 557
Average time to close issues: 11 months
Average time to close pull requests: 7 days
Total issue authors: 4
Total pull request authors: 4
Average comments per issue: 1.23
Average comments per pull request: 2.81
Merged pull request: 224
Bot issues: 0
Bot pull requests: 505

Past year issues: 3
Past year pull requests: 288
Past year average time to close issues: N/A
Past year average time to close pull requests: 7 days
Past year issue authors: 3
Past year pull request authors: 3
Past year average comments per issue: 1.0
Past year average comments per pull request: 3.02
Past year merged pull request: 113
Past year bot issues: 0
Past year bot pull requests: 271

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/frontendnetwork/veganify

Top Issue Authors

  • philipbrembeck (9)
  • maltfield (2)
  • felipe-lemos (1)
  • teolemon (1)

Top Pull Request Authors

  • dependabot[bot] (505)
  • philipbrembeck (50)
  • felipe-lemos (1)
  • NilsJacobsen (1)

Top Issue Labels

  • enhancement (4)
  • mid priority (4)
  • Accessibility (4)
  • bug (2)
  • weekend project (2)
  • help wanted (2)
  • tasks (2)
  • 🌍 Localization (2)
  • low priority (1)
  • needs priority (1)
  • good first issue (1)
  • high priority (1)
  • dependencies (1)

Top Pull Request Labels

  • dependencies (506)
  • Javascript (404)
  • github_actions (101)
  • automerge (31)
  • 🌍 Localization (1)

Dependencies

package-lock.json npm
  • barcode-reader 1.6.1
  • jquery 3.6.0
  • pwa-install-prompt 1.1.1
package.json npm
  • barcode-reader ^1.6.1
  • jquery ^3.6.0
  • pwa-install-prompt ^1.1.1
.github/workflows/build.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action 9311bf5263ae5b36f3ec67aff768790c6e2344ad composite
  • docker/login-action cf8514a65188af1d4f94f8c28a7a4153af1088ce composite
  • docker/metadata-action 0f8c876bafbf5dbce05c36682ec68e9a0274a48a composite
.github/workflows/pr.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
Dockerfile docker
  • base latest build
  • node lts-alpine build

Score: 7.076653815443951