Veganify API (v0.5)

The official API powering Veganify.

Documentation

Please refer to Veganify API Documentation for a full documentation.

There is an official Wrapper for React, Vue, Svelte, and more available on npm.

Swagger

The OpenAPI.yml is automatically available in this Swagger UI.

Available endpoints

The following endpoints are available within the Veganify API:

• POST: https://api.veganify.app/v0/product/{barcode}
• GET: https://api.veganify.app/v0/ingredients/{ingredientslist}
• GET: https://api.veganify.app/v0/peta/crueltyfree

Development

To run the API locally, you first need to set up the environment variables. You can do this by creating a .env file based on the .env.example file. Here, you need to set DEEPL_AUTH to a valid DeepL API key (you can get one here for free), PUSHOVER_TOKEN and PUSHOVER_USER can be left blank, and USER_ID_OEANDB to your OpenEANDB user key. For Development purposes, you can just provide a dummy value for the USER_ID_OEANDB key.

After setting up the .env file, you can run the following commands to get everything up and running:

npm install
npm run start:dev

Before committing any changes, you need to make sure that your code passes the linter and the tests. Run npm run lint and npm run test to check if everything is ok.

Updating the Vegan and Non-Vegan ingredient lists

Before committing changes to the isnotvegan.json and isvegan.json lists, format and process them by running the following command:

npm run process:vegan
npm run process:notvegan