Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 1.44 KB
Raw

Contributing to Open Prices Frontend

Help with translating

The translation for all openfoodfacts GitHub repositories, including this one, is done in a Crowdin project: https://crowdin.com/project/openfoodfacts

In Crowdin, after selecting the target language, add open-prices-frontend as a filter to check the translations that only belong to this GitHub repository.

Help with developing

Installation

If you don't already have Node.js install, we recommend using nvm to manage different node versions.

We use the yarn for package management.

Run the project

  1. Install/update packages with command yarn

  2. Run in development mode with yarn dev

    After this you should be able to access the website at http://localhost:5173/.

  3. Run the back-end on your device. To do so, get and run the code of the server here: https://github.com/openfoodfacts/open-prices.

  4. You can start your first contribution 🎉

Build

yarn build

Lint

yarn lint

There is also a pre-commit configuration set up with husky and lint-staged.

Tests

yarn test

Update packages

// 1) list packages to update
yarn upgrade-interactive --latest
// 2) update package.json by bumping all non-major updgrades
// 3) update packages
yarn install