mirror of
https://github.com/frontendnetwork/vegancheck.me
synced 2024-11-15 00:27:08 +00:00
101 lines
7.7 KiB
HTML
101 lines
7.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-color-mode="dark" data-dark-theme="dark">
|
|
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta charset="utf-8">
|
|
<title>VeganCheck.me Installation Guide</title>
|
|
<link rel="stylesheet" href="https://unpkg.com/@primer/css@^20.2.4/dist/primer.css">
|
|
<link rel="stylesheet" href="assets/prism.css">
|
|
<style>
|
|
body {
|
|
width: 50%;
|
|
}
|
|
|
|
@media only screen and (max-width: 750px) {
|
|
body {
|
|
width: 95%;
|
|
}
|
|
.logo_12 {
|
|
display: none;
|
|
}
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="m-5 mx-auto">
|
|
<div class="markdown-body">
|
|
<span class="branch-name">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16" class="octicon octicon-git-branch">
|
|
<path fill-rule="evenodd" d="M11.75 2.5a.75.75 0 100 1.5.75.75 0 000-1.5zm-2.25.75a2.25 2.25 0 113 2.122V6A2.5 2.5 0 0110 8.5H6a1 1 0 00-1 1v1.128a2.251 2.251 0 11-1.5 0V5.372a2.25 2.25 0 111.5 0v1.836A2.492 2.492 0 016 7h4a1 1 0 001-1v-.628A2.25 2.25 0 019.5 3.25zM4.25 12a.75.75 0 100 1.5.75.75 0 000-1.5zM3.5 3.25a.75.75 0 111.5 0 .75.75 0 01-1.5 0z"></path>
|
|
</svg>
|
|
main
|
|
</span>
|
|
|
|
<span class="Label mr-1 Label--success">Stable</span>
|
|
<img width="80px" src="https://raw.githubusercontent.com/JokeNetwork/vegancheck.me/main/public/img/hero_icon.png" align="right" alt="VeganCheck Logo" class="logo_12">
|
|
<h1>VeganCheck.me Installation Guide</h1>
|
|
<p>Installing VeganCheck.me on your own server or hosting your own mirror is straight forward.<br>Here you can find out how it works and what to note.</p>
|
|
<h2 id="vercek">Deploy to Vercel</h2>
|
|
<p>The easiest way is to deploy the project to Vercel. Please note that Vercel is not GDPR compliant.</p>
|
|
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FJokeNetwork%2Fvegancheck.me"><img src="https://vercel.com/button" alt="Deploy with Vercel"/></a>
|
|
<h2 id="requirements">Requirements</h2>
|
|
<ul>
|
|
<li>Node.js (React 18.2.0, Next.js 13.1.6) installed
|
|
<li><a href="https://docs.npmjs.com/cli/v8/commands/npm-install">npm</a> installed (is automatically installed with Node)</li>
|
|
<li>or: <a href="https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable">Yarn</a> installed (<code>npm install --global yarn</code>)</li>
|
|
</ul>
|
|
<h2 id="get-started">Get started</h2>
|
|
<p>Download the <a href="https://github.com/JokeNetwork/vegancheck.me/releases">latest release</a> or just use the following command:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="language-bash">$ git clone https://github.com/JokeNetwork/vegancheck.me.git</code></pre></div>
|
|
<h2 id="install-dependencies">Install dependencies</h2>
|
|
<p>Use the following commands to install all at once: </p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ npm <span class="hljs-keyword">install</span></code></pre></div>
|
|
<p>or:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ yarn <span class="hljs-keyword">install</span></code></pre></div>
|
|
<h2 id="start-the-service">Start the service</h2>
|
|
<p>In a local environment you can just run:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ npm run start</span></code></pre></div>
|
|
<p>or:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ yarn start</span></code></pre></div>
|
|
<p>To build the service just run:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ npm run build</span></code></pre></div>
|
|
<p>or:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ yarn build</span></code></pre></div>
|
|
<p>You can then run the code in a normal Node.js production environment (Like with the help of <a href="http://supervisord.org">supervisord</a>).</p>
|
|
<p>Please note that the service runs on <code>Port 1030</code>. You can change the port by editing the "start" command in the <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/package.json">package.json</a> at <code>"start": "next start -p [Desired port]"</code>.</p>
|
|
<h2 id="use-tests">Use Frontend Tests</h2>
|
|
<p>We use the Playwright Framework for our Frontend tests.<br />
|
|
For more information about Playwright, please visit <a href="https://playwright.dev">https://playwright.dev</a>.</p>
|
|
<p>To run the tests, just start the dev-environment:</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ npm run dev</code></pre></div>
|
|
<p>and then</p>
|
|
<div class="highlight"><pre class="highlight"><code class="lang-bash">$ npm run test</code></pre></div>
|
|
<p>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 <code>src/tests/usability.spec.ts</code>.</p>
|
|
<h2 id="use-of-icons">Use of icons</h2>
|
|
<ul>
|
|
<li>The VeganCheck.me Logo and the app icons are free to use under the terms of the <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/LICENSE">MIT License</a>.</li>
|
|
<li>The Open-Source logo is free to use, as long as you publish your fork of the repository openly.</li>
|
|
<li>The Green Hosted logo is free to use under the terms of the <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/LICENSE">MIT License</a>, but only to be used if your fork is actually hosted green as of the criteria of <a href="https://www.thegreenwebfoundation.org">The Green Web Foundation</a>.</li>
|
|
<li>The We plant trees. logo is free to use under the terms of the <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/LICENSE">MIT License</a>, but only to be used if your fork of VeganCheck.me plants trees in the tree planting team "WE PLANT TREES." on <a href="https://iplantatree.org/user/VeganCheck.me">I Plant A Tree</a>.</li>
|
|
<li>The icons used in our iconfonts are free to use under the terms of the <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/LICENSE">MIT License</a>.</li>
|
|
<div class="flash flash-warn p-3 mt-3 mb-3" role="alert">
|
|
<strong>Important!</strong> All other icons used in the VeganCheck.me repo are exclusively licensed to VeganCheck.me and the VeganCheck.me domain by <a href="https://thenounproject.com">Noun Project</a>. If you want to use those icons, you will need to get a paid membership at Noun Project: <a href="https://thenounproject.com/pricing/">NounPro Unlimited</a>. Otherwise, please replace those icons.
|
|
</div>
|
|
</ul>
|
|
<h2 id="api-documentation">API documentation</h2>
|
|
<p>The API documentation was relocated and can now be found at one of the following locations:</p>
|
|
<ul>
|
|
<li><a href="https://jokenetwork.de/vegancheck-api">VeganCheck.me API at JokeNetwork</a></li>
|
|
<li><a href="https://jokenetwork.de/vegancheck-ingredients-api">VeganCheck.me Ingredients API at JokeNetwork</a></li>
|
|
<li><a href="https://jokenetwork.de/vegancheck-peta-api">VeganCheck.me PETA API at JokeNetwork</a></li>
|
|
</ul>
|
|
<footer class="border-top">
|
|
<p class="color-fg-muted mt-2">© 2023 <a href="//vegancheck.me">VeganCheck.me</a> - Licensed under <a href="https://github.com/JokeNetwork/vegancheck.me/blob/main/LICENSE">MIT</a></p>
|
|
</footer>
|
|
</div>
|
|
<script src="assets/prism.js"></script>
|
|
</body>
|
|
|
|
</html>
|