Ocelot-Social/assets/index.html-CtTXU5Um.js

import{_ as o}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as r,a as l,b as s,d as i,e as a,f as n,r as h,o as d}from"./app-42vVvAb-.js";const p={};function c(k,e){const t=h("RouteLink");return d(),r("div",null,[e[31]||(e[31]=l('<h1 id="ocelot-social" tabindex="-1"><a class="header-anchor" href="#ocelot-social"><span>Ocelot.Social</span></a></h1><p><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml" target="_blank" rel="noopener noreferrer"><img src="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml/badge.svg?branch=master" alt="Backend Test CI" loading="lazy"></a><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml" target="_blank" rel="noopener noreferrer"><img src="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml/badge.svg?branch=master" alt="Webapp Test CI" loading="lazy"></a><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml" target="_blank" rel="noopener noreferrer"><img src="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml/badge.svg?branch=master" alt="E2E Test CI" loading="lazy"></a><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions" target="_blank" rel="noopener noreferrer"><img src="https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/publish.yml/badge.svg" alt="Build Status Publish" loading="lazy"></a><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/LICENSE.md" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT License" loading="lazy"></a><a href="https://discord.gg/AJSX9DCSUA" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/discord/489522408076738561.svg" alt="Discord Channel" loading="lazy"></a><a href="https://www.codetriage.com/ocelot-social-community/ocelot-social" target="_blank" rel="noopener noreferrer"><img src="https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg" alt="Open Source Helpers" loading="lazy"></a></p><p><a href="https://ocelot.social" target="_blank" rel="noopener noreferrer">Ocelot.social</a> is free and open source software program code to run social networks. Its development is supported by a community of programmers and interested network operators.</p><p style="text-align:center;"><a href="https://ocelot.social" target="_blank"><img src="https://raw.githubusercontent.com/Ocelot-Social-Community/Ocelot-Social/master/webapp/static/img/custom/logo-squared.svg" alt="ocelot.social" width="40%" height="40%"></a></p><p>Our goal is to enable people to participate fairly and equally in online social networks. The equality of opportunity applies both to the fundamental equality of all people and to the possibility of letting their diverse voices be heard.</p><p>We therefore consider it desirable that operators offer such networks so that people can choose where they want to be on the move.</p><p>Our vision for the future is that at some point it should be possible to link these networks together (ActivityPub, Fediverse) so that users can also connect with people from other networks - for example, by friending them or following posts or other contributions.</p><p>If you would like to help set up this capability with us, please contact us.</p><p>In other words, we are interested in a network of networks and in keeping the data as close as possible to the user and the operator they trusts.</p><h2 id="screenshots" tabindex="-1"><a class="header-anchor" href="#screenshots"><span>Screenshots</span></a></h2><img src="https://user-images.githubusercontent.com/17728384/218597429-554e4082-3906-4721-8f68-0c13146fc218.png" alt="Post feed" title="Post feed"><p>Check out more screenshots <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:Screenshots" target="_blank" rel="noopener noreferrer">here</a>.</p><h2 id="features" tabindex="-1"><a class="header-anchor" href="#features"><span>Features</span></a></h2><p>Ocelot.social networks features:</p><ul><li><strong>news feed</strong></li><li><strong>posts</strong></li><li>as <strong>articles</strong> and <strong>events</strong></li><li><strong>comments</strong></li><li><strong>filter</strong></li><li><strong>search</strong></li><li><strong>groups</strong></li><li><strong>map</strong></li><li><strong>user accounts</strong></li><li><strong>user roles</strong></li><li>make your own <strong>branded network</strong></li><li>and more …</li></ul><p>Check out the <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ#what-are-the-features" target="_blank" rel="noopener noreferrer">full feature list</a>.</p><h2 id="user-guide-and-frequently-asked-questions" tabindex="-1"><a class="header-anchor" href="#user-guide-and-frequently-asked-questions"><span>User Guide and Frequently Asked Questions</span></a></h2><p>In the <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki" target="_blank" rel="noopener noreferrer">wiki</a> you can find more information.</p><ul><li><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:User-Guide" target="_blank" rel="noopener noreferrer">User Guide</a></li><li><a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ" target="_blank" rel="noopener noreferrer">Frequently Asked Questions</a></li></ul><h2 id="demo" tabindex="-1"><a class="header-anchor" href="#demo"><span>Demo</span></a></h2><p>Try out our live demo network, see <a href="#live-demo-and-developer-logins">here</a>.</p><h2 id="help-us" tabindex="-1"><a class="header-anchor" href="#help-us"><span>Help us</span></a></h2><p>If you&#39;re wondering how you could help, there are plenty of ways, e.g.:</p>',23)),s("ul",null,[e[5]||(e[5]=l('<li>Spread the good word about ocelot.social to make it more popular: <ul><li>Add the link <a href="https://ocelot.social" target="_blank" rel="noopener noreferrer">ocelot.social</a> to your website.</li><li>Give ocelot.social a Like at <a href="https://alternativeto.net/software/ocelot-social/" target="_blank" rel="noopener noreferrer">https://alternativeto.net/software/ocelot-social/</a>.</li><li>Star our project on GitHub at <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/" target="_blank" rel="noopener noreferrer">https://github.com/Ocelot-Social-Community/Ocelot-Social/</a>.</li><li>Promote it on your social networks.</li><li>Tell your friends about it by word-of-mouth.</li><li>Write a press article on ocelot.social or contact the editorial office of your local news page or radio station.</li></ul></li>',1)),s("li",null,[e[1]||(e[1]=i("Take a ")),e[2]||(e[2]=s("a",{href:"https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22",target:"_blank",rel:"noopener noreferrer"},"good first issue",-1)),e[3]||(e[3]=i(" or issues that need help. Make sure to read ")),a(t,{to:"/CONTRIBUTING.html"},{default:n(()=>e[0]||(e[0]=[i("CONTRIBUTING.md")])),_:1}),e[4]||(e[4]=i(" first though."))]),e[6]||(e[6]=s("li",null,[i("Testing and "),s("a",{href:"https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/new/choose",target:"_blank",rel:"noopener noreferrer"},"reporting"),i(" bugs.")],-1)),e[7]||(e[7]=s("li",null,[i("Translating: Please "),s("a",{href:"#contact"},"contact us"),i(".")],-1)),e[8]||(e[8]=s("li",null,"Reviewing and testing pull requests.",-1))]),e[32]||(e[32]=l(`<h2 id="donate" tabindex="-1"><a class="header-anchor" href="#donate"><span>Donate</span></a></h2><p>Your donation is very welcome and helps to enhance and improve the network. This software is mostly developed and maintained by the association <a href="https://www.busfaktor.org/en" target="_blank" rel="noopener noreferrer">busFaktor() e.V.</a> . Please support us with a <a href="https://www.busfaktor.org/en/donations" target="_blank" rel="noopener noreferrer">donation</a> to busFaktor() e.V. . Thanks a lot! ❤️</p><h2 id="contact" tabindex="-1"><a class="header-anchor" href="#contact"><span>Contact</span></a></h2><p>Are you interested in operating your own ocelot.social network or becoming a user? Please contact us here:</p><ul><li><a href="mailto:hello@ocelot.social" target="_blank" rel="noopener noreferrer">hello@ocelot.social</a></li><li>our developer chat on <a href="https://discord.gg/AJSX9DCSUA" target="_blank" rel="noopener noreferrer">Discord</a></li></ul><h2 id="for-developers-and-contributors" tabindex="-1"><a class="header-anchor" href="#for-developers-and-contributors"><span>For Developers and Contributors</span></a></h2><h3 id="introduction" tabindex="-1"><a class="header-anchor" href="#introduction"><span>Introduction</span></a></h3><p>Have a look into our short video: <a href="https://www.youtube.com/watch?v=gZSL6KvBIiY&amp;list=PLFMD5liPP01kbuReHxYXxv_1fI5rIgS1f&amp;index=1" target="_blank" rel="noopener noreferrer">ocelot.social - GitHub - Developer Welcome - Tutorial (english)</a></p><h3 id="directory-layout" tabindex="-1"><a class="header-anchor" href="#directory-layout"><span>Directory Layout</span></a></h3><p>There are three important directories:</p><ul><li><a href="./backend">Backend</a> runs on the server and is a middleware between database and frontend</li><li><a href="./webapp">Frontend</a> is a server-side-rendered and client-side-rendered web frontend</li><li><a href="./cypress">Cypress</a> contains end-to-end tests and executable feature specifications</li></ul><p>In order to setup the application and start to develop features you have to setup <strong>webapp</strong> and <strong>backend</strong>.</p><p>There are two approaches:</p><ol><li><a href="#local-installation">Local</a> installation, which means you have to take care of dependencies yourself.</li><li><strong>Or</strong> install everything through <a href="#docker-installation">Docker</a> which takes care of dependencies for you.</li></ol><h3 id="installation" tabindex="-1"><a class="header-anchor" href="#installation"><span>Installation</span></a></h3><h4 id="clone-the-repository" tabindex="-1"><a class="header-anchor" href="#clone-the-repository"><span>Clone the Repository</span></a></h4><p>Clone the repository, this will create a new folder called <code>Ocelot-Social</code>:</p><p>Using HTTPS:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> git</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> clone</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> https://github.com/Ocelot-Social-Community/Ocelot-Social.git</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Using SSH:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> git</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> clone</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> git@github.com:Ocelot-Social-Community/Ocelot-Social.git</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Change into the new folder.</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> cd</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> Ocelot-Social</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="live-demo-and-developer-logins" tabindex="-1"><a class="header-anchor" href="#live-demo-and-developer-logins"><span>Live Demo and Developer Logins</span></a></h3><p><strong>Try out our deployed <a href="https://stage.ocelot.social" target="_blank" rel="noopener noreferrer">development environment</a>.</strong></p><p>Visit our staging networks:</p><ul><li>central staging network: <a href="https://stage.ocelot.social" target="_blank" rel="noopener noreferrer">stage.ocelot.social</a></li></ul><h4 id="login" tabindex="-1"><a class="header-anchor" href="#login"><span>Login</span></a></h4><p>Logins for the live demos and developers (local developers after the following installations) in the browser:</p><table><thead><tr><th style="text-align:left;">email</th><th style="text-align:left;">password</th><th style="text-align:left;">role</th></tr></thead><tbody><tr><td style="text-align:left;"><code>user@example.org</code></td><td style="text-align:left;">1234</td><td style="text-align:left;">user</td></tr><tr><td style="text-align:left;"><code>moderator@example.org</code></td><td style="text-align:left;">1234</td><td style="text-align:left;">moderator</td></tr><tr><td style="text-align:left;"><code>admin@example.org</code></td><td style="text-align:left;">1234</td><td style="text-align:left;">admin</td></tr></tbody></table><h4 id="docker-installation" tabindex="-1"><a class="header-anchor" href="#docker-installation"><span>Docker Installation</span></a></h4><p>Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.</p><h5 id="general-installation-of-docker" tabindex="-1"><a class="header-anchor" href="#general-installation-of-docker"><span>General Installation of Docker</span></a></h5><p>There are <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">several ways to install Docker</a> on your computer or server.</p><p>Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># use Docker version 24.0.6 or newer</span></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># includes Docker Compose</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> --version</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="start-ocelot-social-via-docker-compose" tabindex="-1"><a class="header-anchor" href="#start-ocelot-social-via-docker-compose"><span>Start Ocelot-Social via Docker Compose</span></a></h5><p><em><strong>ATTENTION:</strong> For using Docker commands in Apple Silicon environments see <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md#apple-silicon-platform" target="_blank" rel="noopener noreferrer">here</a>.</em></p><p>Prepare ENVs once beforehand:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in folder webapp/</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> cp</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> .env.template</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> .env</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in folder backend/</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> cp</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> .env.template</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> .env</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">For</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> Development:</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;">\`\`\`</span><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">bash</span></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in main folder</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker compose up</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>For Production:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in main folder</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> -f</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker-compose.yml</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> up</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><p>This will start all required Docker containers.<br> Make sure your database is running on <code>http://localhost:7474/browser/</code>.</p><p>Prepare database once before you start by running the following command in a second terminal:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in main folder while docker compose is up</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> exec</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> backend</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> db:migrate</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> init</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> exec</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> backend</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> db:migrate</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> up</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Then clear and seed database by running the following command as well in the second terminal:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in main folder while docker compose is up</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> exec</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> backend</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> db:reset</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> exec</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> backend</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> db:seed</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,47)),s("p",null,[e[11]||(e[11]=i("For a closer description see ")),a(t,{to:"/backend/"},{default:n(()=>e[9]||(e[9]=[i("backend")])),_:1}),e[12]||(e[12]=i(".")),e[13]||(e[13]=s("br",null,null,-1)),e[14]||(e[14]=i(" For a full documentation of the Docker installation see ")),a(t,{to:"/SUMMARY.html"},{default:n(()=>e[10]||(e[10]=[i("summary")])),_:1}),e[15]||(e[15]=i("."))]),e[33]||(e[33]=s("h4",{id:"local-installation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#local-installation"},[s("span",null,"Local Installation")])],-1)),s("p",null,[e[17]||(e[17]=i("For a full documentation of the local installation see ")),a(t,{to:"/SUMMARY.html"},{default:n(()=>e[16]||(e[16]=[i("summary")])),_:1}),e[18]||(e[18]=i("."))]),e[34]||(e[34]=l(`<h3 id="contributing" tabindex="-1"><a class="header-anchor" href="#contributing"><span>Contributing</span></a></h3><p>Choose an issue (consider our label <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22" target="_blank" rel="noopener noreferrer">good-first-issue</a>) and leave a comment there. We will then invite you to join our volunteers team. To have the necessary permission to push directly to this repository, please accept our invitation to join our volunteers team, you will receive via the email, Github will send you, once invited. If we did not invite you yet, please request an invitation via Discord.</p><p>We are happy if you fork our repository, but we don&#39;t recommend it for development. You do not need a fork.</p><p>Clone this repository locally as <a href="#clone-the-repository">described above</a>, create your branch named <code>&lt;issue-number&gt;-&lt;description&gt;</code>, add your code and push your branch direct to this repository. Then create a PR by comparing it to our <code>master</code>.</p><p><em><strong>!!! Be aware:</strong></em> Please don&#39;t compare from a fork, because the tests are breaking caused by credential problems.</p><p>Please run the following commands before you push:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in folder backend/</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> lint</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> --fix</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> test</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in folder webapp/</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> lint</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> --fix</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> locales</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> --fix</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> yarn</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> test</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Check out our <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">contribution guideline</a>, too!</p><h4 id="developer-chat" tabindex="-1"><a class="header-anchor" href="#developer-chat"><span>Developer Chat</span></a></h4><p>Join our friendly open-source community on <a href="https://discord.gg/AJSX9DCSUA" target="_blank" rel="noopener noreferrer">Discord</a> 😻 Just introduce yourself at <code>#introduce-yourself</code> and mention a mentor or <code>@@Mentors</code> to get you onboard 🤓</p><p>We give write permissions to every developer who asks for it. Just text us on <a href="https://discord.gg/AJSX9DCSUA" target="_blank" rel="noopener noreferrer">Discord</a>.</p><h3 id="deployment" tabindex="-1"><a class="header-anchor" href="#deployment"><span>Deployment</span></a></h3>`,13)),s("p",null,[e[20]||(e[20]=i("Deployment methods can be found in our ")),e[21]||(e[21]=s("code",null,"deployment",-1)),e[22]||(e[22]=i(" folder described in the ")),a(t,{to:"/deployment/"},{default:n(()=>e[19]||(e[19]=[i("README")])),_:1}),e[23]||(e[23]=i(". Our branding template is our ")),e[24]||(e[24]=s("a",{href:"https://github.com/Ocelot-Social-Community/stage.ocelot.social",target:"_blank",rel:"noopener noreferrer"},"stage.ocelot.social",-1)),e[25]||(e[25]=i(" repository. Place your branding repository inside ")),e[26]||(e[26]=s("code",null,"deployment/configurations",-1)),e[27]||(e[27]=i("."))]),e[35]||(e[35]=l(`<p>The only deployment method in this repository for production purposes is <a href="https://kubernetes.io" target="_blank" rel="noopener noreferrer">Kubernetes</a> for now. But we just started to develop a deployment for <a href="https://docs.docker.com/compose/" target="_blank" rel="noopener noreferrer">Docker Compose</a> as well.</p><p>The only deployment method with branding in this repository for development purposes as described above is <a href="https://docs.docker.com/compose/" target="_blank" rel="noopener noreferrer">Docker Compose</a>:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># in folder deployment/</span></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># set your branding folder name in .env</span></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># then run</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">$</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docker</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> compose</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> up</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>The code is branded automatically. To setup the Neo4j database see above.</p><h3 id="technology-stack" tabindex="-1"><a class="header-anchor" href="#technology-stack"><span>Technology Stack</span></a></h3><ul><li><a href="https://vuejs.org/" target="_blank" rel="noopener noreferrer">VueJS</a></li><li><a href="https://nuxtjs.org/" target="_blank" rel="noopener noreferrer">NuxtJS</a></li><li><a href="https://graphql.org/" target="_blank" rel="noopener noreferrer">GraphQL</a></li><li><a href="https://nodejs.org/en/" target="_blank" rel="noopener noreferrer">NodeJS</a></li><li><a href="https://neo4j.com/" target="_blank" rel="noopener noreferrer">Neo4J</a></li></ul><h4 id="for-testing" tabindex="-1"><a class="header-anchor" href="#for-testing"><span>For Testing</span></a></h4><ul><li><a href="https://docs.cypress.io/" target="_blank" rel="noopener noreferrer">Cypress</a></li><li><a href="https://storybook.js.org/" target="_blank" rel="noopener noreferrer">Storybook</a></li><li><a href="https://jestjs.io/" target="_blank" rel="noopener noreferrer">Jest</a></li><li><a href="https://vue-test-utils.vuejs.org/" target="_blank" rel="noopener noreferrer">Vue Test Utils</a></li><li><a href="https://eslint.org/" target="_blank" rel="noopener noreferrer">ESLint</a></li></ul><h3 id="attributions" tabindex="-1"><a class="header-anchor" href="#attributions"><span>Attributions</span></a></h3><p>Locale Icons made by <a href="http://www.freepik.com/" target="_blank" rel="noopener noreferrer">Freepik</a> from <a href="https://www.flaticon.com/" target="_blank" rel="noopener noreferrer">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" target="_blank" rel="noopener noreferrer">CC 3.0 BY</a>.</p><p>Browser compatibility testing with <a href="https://www.browserstack.com/" target="_blank" rel="noopener noreferrer">BrowserStack</a>.</p><img alt="BrowserStack Logo" src="https://raw.githubusercontent.com/Ocelot-Social-Community/Ocelot-Social/master/.gitbook/assets/browserstack-logo.svg" width="256"><h3 id="license" tabindex="-1"><a class="header-anchor" href="#license"><span>License</span></a></h3>`,13)),s("p",null,[e[29]||(e[29]=i("See the ")),a(t,{to:"/LICENSE.html"},{default:n(()=>e[28]||(e[28]=[i("LICENSE")])),_:1}),e[30]||(e[30]=i(" file for license rights and limitations (MIT)."))])])}const m=o(p,[["render",c],["__file","index.html.vue"]]),b=JSON.parse('{"path":"/","title":"Ocelot.Social","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Screenshots","slug":"screenshots","link":"#screenshots","children":[]},{"level":2,"title":"Features","slug":"features","link":"#features","children":[]},{"level":2,"title":"User Guide and Frequently Asked Questions","slug":"user-guide-and-frequently-asked-questions","link":"#user-guide-and-frequently-asked-questions","children":[]},{"level":2,"title":"Demo","slug":"demo","link":"#demo","children":[]},{"level":2,"title":"Help us","slug":"help-us","link":"#help-us","children":[]},{"level":2,"title":"Donate","slug":"donate","link":"#donate","children":[]},{"level":2,"title":"Contact","slug":"contact","link":"#contact","children":[]},{"level":2,"title":"For Developers and Contributors","slug":"for-developers-and-contributors","link":"#for-developers-and-contributors","children":[{"level":3,"title":"Introduction","slug":"introduction","link":"#introduction","children":[]},{"level":3,"title":"Directory Layout","slug":"directory-layout","link":"#directory-layout","children":[]},{"level":3,"title":"Installation","slug":"installation","link":"#installation","children":[]},{"level":3,"title":"Live Demo and Developer Logins","slug":"live-demo-and-developer-logins","link":"#live-demo-and-developer-logins","children":[]},{"level":3,"title":"Contributing","slug":"contributing","link":"#contributing","children":[]},{"level":3,"title":"Deployment","slug":"deployment","link":"#deployment","children":[]},{"level":3,"title":"Technology Stack","slug":"technology-stack","link":"#technology-stack","children":[]},{"level":3,"title":"Attributions","slug":"attributions","link":"#attributions","children":[]},{"level":3,"title":"License","slug":"license","link":"#license","children":[]}]}],"git":{"createdTime":1752750935000,"updatedTime":1752750935000,"contributors":[{"name":"dependabot[bot]","email":"49699333+dependabot[bot]@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":5.45,"words":1634},"filePathRelative":"README.md","localizedDate":"July 17, 2025","excerpt":"\\n<p><a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml/badge.svg?branch=master\\" alt=\\"Backend Test CI\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml/badge.svg?branch=master\\" alt=\\"Webapp Test CI\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml/badge.svg?branch=master\\" alt=\\"E2E Test CI\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/publish.yml/badge.svg\\" alt=\\"Build Status Publish\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/LICENSE.md\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://img.shields.io/badge/license-MIT-green.svg\\" alt=\\"MIT License\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://discord.gg/AJSX9DCSUA\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://img.shields.io/discord/489522408076738561.svg\\" alt=\\"Discord Channel\\" loading=\\"lazy\\"></a>\\n<a href=\\"https://www.codetriage.com/ocelot-social-community/ocelot-social\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><img src=\\"https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg\\" alt=\\"Open Source Helpers\\" loading=\\"lazy\\"></a></p>"}');export{m as comp,b as data};