main Stable Veganify Logo

veganify.app Installation Guide

Installing veganify.app on your own server or hosting your own mirror is straight forward.
Here you can find out how it works and what to note.

Deploy to Vercel

The easiest way is to deploy the project to Vercel. Please note that Vercel is not GDPR compliant.

Requirements

Node.js (React 18.2.0, Next.js 13.1.6) installed
npm installed (is automatically installed with Node)
or: Yarn installed (npm install --global yarn)

Get started

Download the latest release or just use the following command:

$ git clone https://github.com/JokeNetwork/veganify.app.git

Install dependencies

Use the following commands to install all at once:

$ npm install

or:

$ yarn install

Start the service

In a local environment you can just run:

$ npm run start

or:

$ yarn start

To build the service just run:

$ npm run build

or:

$ yarn build

You can then run the code in a normal Node.js production environment (Like with the help of supervisord).

Please note that the service runs on Port 1030. You can change the port by editing the "start" command in the package.json at "start": "next start -p [Desired port]".

Use Frontend Tests

We use the Playwright Framework for our Frontend tests.
For more information about Playwright, please visit https://playwright.dev.

To run the tests, just start the dev-environment:

$ npm run dev

and then

$ npm run test

All test should pass. Those test only check for the usabilty of the page. If you want to write your own tests, you can find the tests in src/tests/usability.spec.ts.

Use of icons

The veganify.app Logo and the app icons are free to use under the terms of the MIT License.
The Open-Source logo is free to use, as long as you publish your fork of the repository openly.
The Green Hosted logo is free to use under the terms of the MIT License, but only to be used if your fork is actually hosted green as of the criteria of The Green Web Foundation.
The We plant trees. logo is free to use under the terms of the MIT License, but only to be used if your fork of veganify.app plants trees in the tree planting team "WE PLANT TREES." on I Plant A Tree.
The icons used in our iconfonts are free to use under the terms of the MIT License.

Important! All other icons used in the veganify.app repo are exclusively licensed to veganify.app and the veganify.app domain by Noun Project. If you want to use those icons, you will need to get a paid membership at Noun Project: NounPro Unlimited. Otherwise, please replace those icons.

API documentation

The API documentation was relocated and can now be found at one of the following locations: