diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 50d3721d1..27a4ed15a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,41 +1,43 @@
# CONTRIBUTING
-Thank you so much for thinking of contributing to the Human Connection project! It's awesome you're here, we really appreciate it. :-\)
+Thank you so much for thinking of contributing to the [ocelot.social](https://ocelot.social) project! It's awesome you're here, we really appreciate it. :-\)
## Getting Set Up
-Instructions for how to install all the necessary software and some code guidelines can be found in our main [Readme](/README.md) or in our [documentation](https://docs.human-connection.org/human-connection/).
+Instructions for how to install all the necessary software and some code guidelines can be found in our main [Readme](/README.md) or in our [documentation](/SUMMARY.md).
To get you started we recommend that you join forces with a regular contributor. Please join [our Discord instance](https://discord.gg/AJSX9DCSUA) to chat with developers or just get in touch directly on an issue on either [Github](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) or [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089):
-
-
-We also have regular pair programming sessions that you are very welcome to join! We feel this is often the best way to get to know both the project and the team. Most developers are also available for spontaneous sessions if the times listed below don't work for you – just ping us on Discord.
+We also can have pair programming sessions for you! We feel this is often the best way to get to know both the project and the team. Most developers are also available for spontaneous sessions.
## Development Flow
We operate in two week sprints that are planned, estimated and prioritised on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089). All issues are also linked to and synced with [Github](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues). Look for the `good first issue` label if you're not sure where to start!
-We try to discuss all questions directly related to a feature or bug in the respective issue, in order to preserve it for the future and for other developers. We use Discord for real-time communication.
+We try to discuss all questions directly related to a feature or bug in the respective issue, in order to preserve it for the future and for other developers. We use [Discord](https://discord.gg/AJSX9DCSUA) for real-time communication.
This is how we solve bugs and implement features, step by step:
1. We find an issue we want to work on, usually during the sprint planning but as an open source contributor this can happen at any time.
-2. We communicate with the team to see if the issue is still available. (When you comment on an issue but don't get an answer there within 1-2 days try to mention @Human-Connection/hc-dev-team to make sure we check in.)
+2. We communicate with the team to see if the issue is still available. (When you comment on an issue but don't get an answer there within 1-2 days try to mention @Ocelot-Social-Community/core-team to make sure we check in.)
3. We make sure we understand the issue in detail – what problem is it solving and how should it be implemented?
4. We assign ourselves to the issue and move it to `In Progress` on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089).
5. We start working on it in a `new branch` and open a `pull request` prefixed with `[WIP]` (work in progress) to which we regularly push our changes.
6. When questions come up we clarify them with the team (directly in the issue on Github).
-7. When we are happy with our work and our PR is passing all tests we remove the `[WIP]` from the PR description and ask for reviews (if you're not sure who to ask there is @Human-Connection/hc-dev-team which pings all core developers).
+7. When we are happy with our work and our PR is passing all tests we remove the `[WIP]` from the PR description and ask for reviews (if you're not sure who to ask there is @Ocelot-Social-Community/core-team which pings all core developers).
8. We then incorporate the suggestions from the reviews into our work and once it has been approved it can be merged into master!
Every pull request needs to:
* fix an issue (if there is something you want to work on but there is no issue for it, create one first and discuss it with the team)
* include tests for the code that is added or changed
-* pass all tests (linter, backend, frontend, end-to-end)
+* pass all tests (linter, backend, webapp, code coverage, end-to-end)
* be approved by at least 1 developer who is not the owner of the PR (when more than 10 files were changed it needs 2 approvals)
+## Contribution Flow For Open Source Contributors
+
+See [contributing in main README.md](/README.md#contributing)
+
## The Team
There are many volunteers all around the world helping us build this network and without their contributions we wouldn't be where we are today. Big thank you to all of you!
@@ -55,7 +57,7 @@ You can talk to our core team on [Discord](https://discord.gg/AJSX9DCSUA). And o
## Meetings and Pair Programming Sessions
-Times below refer to **German Time** – that's CET (GMT+1) in winter and CEST (GMT+2) in summer – because most Human Connection core team members are living in Germany.
+Times below refer to **German Time** – that's CET (GMT+1) in winter and CEST (GMT+2) in summer – because most ocelot.social Community core team members are living in Germany.
Daily standup
@@ -109,12 +111,13 @@ We practise [collective code ownership](http://www.extremeprogramming.org/rules/
* we avoid blocking because someone else isn't working, so we sometimes take over PRs from other developers
* everyone should always push their code to branches so others can see it
-We believe in open source contributions as a learning experience – everyone is welcome to join our team of volunteers and to contribute to the project, no matter their background or level of experience.
+We believe in open source contributions as a learning experience – everyone is welcome to join our team of volunteers and to contribute to the project, no matter their background or level of experience. To support your learning experience we founded the charity association [busFaktor() e.V.](https://www.busfaktor.org/en).
We use pair programming sessions as a tool for knowledge sharing. We can learn a lot from each other and only by sharing what we know and overcoming challenges together can we grow as a team and truly own this project collectively.
As a volunteeer you have no commitment except your own self development and your awesomeness by contributing to this free and open-source software project. Cheers to you!
+
diff --git a/LICENSE.md b/LICENSE.md
index c0d3b6e18..cd085aca8 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -2,7 +2,7 @@
MIT License
-Copyright \(c\) 2018 Human-Connection gGmbH
+Copyright \(c\) 2018-2021 [Ocelot.Social Community](https://github.com/Ocelot-Social-Community)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
diff --git a/README.md b/README.md
index 67f94f94c..e7d9b2b72 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,28 @@
-# ocelot.social
+# Ocelot.Social
-[](https://travis-ci.com/Human-Connection/Human-Connection)
-[](https://codecov.io/gh/Human-Connection/Human-Connection/)
-[](https://github.com/Human-Connection/Nitro-Backend/blob/backend/LICENSE.md)
-[](https://discordapp.com/invite/DFSjPaX)
-[](https://www.codetriage.com/human-connection/human-connection)
+[](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions)
+[](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions)
+[](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/LICENSE.md)
+[](https://discord.gg/AJSX9DCSUA)
+[](https://www.codetriage.com/ocelot-social-community/ocelot-social)
-ocelot.social is a nonprofit social, action and knowledge network that connects information to action and promotes positive local and global change in all areas of life.
-
-* **Social**: Interact with other people not just by commenting their posts, but by providing **Pro & Contra** arguments, give a **Versus** or ask them by integrated **Chat** or **Let's Talk**
-* **Knowledge**: Read articles about interesting topics and find related posts in the **More Info** tab or by **Filtering** based on **Categories** and **Tagging** or by using the **Fulltext Search**.
-* **Action**: Don't just read about how to make the world a better place, but come into **Action** by following provided suggestions on the **Action** tab provided by other people or **Organisations**.
+[ocelot.social](https://ocelot.social) 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.
- 
+
-## Live demo
+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.
-__Try out our deployed [development environment](https://develop.human-connection.org/).__
+We therefore consider it desirable that operators offer such networks so that people can choose where they want to be on the move.
-Logins:
+At the same time, it should be possible in the future to link these networks with each other (ActivityPub, Fediverse), so that users can also connect with people from other networks - for example by making friends or following posts or other contributions.
-| email | password | role |
-| :--- | :--- | :--- |
-| `user@example.org` | 1234 | user |
-| `moderator@example.org` | 1234 | moderator |
-| `admin@example.org` | 1234 | admin |
+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.
## Directory Layout
-There are four important directories:
+There are three important directories:
* [Backend](./backend) runs on the server and is a middleware between database and frontend
* [Frontend](./webapp) is a server-side-rendered and client-side-rendered web frontend
@@ -41,8 +33,8 @@ setup **frontend** and **backend**.
There are two approaches:
-1. Local installation, which means you have to take care of dependencies yourself
-2. **Or** Install everything through Docker which takes care of dependencies for you
+1. [Local](#local-installation) installation, which means you have to take care of dependencies yourself.
+2. **Or** Install everything through [Docker](#docker-installation) which takes care of dependencies for you.
## Installation
@@ -91,34 +83,93 @@ docker-compose version 1.23.2
#### Start Ocelot-Social via Docker-Compose
+Prepare ENVs once beforehand:
+
+```bash
+# in folder webapp/
+$ cp .env.template .env
+
+# in folder backend/
+$ cp .env.template .env
+```
+
For Development:
```bash
+# in main folder
$ docker-compose up
```
For Production:
```bash
+# in main folder
$ docker-compose -f docker-compose.yml up
```
-This will start all required Docker containers
+This will start all required Docker containers.
+Make sure your database is running on `http://localhost:7474/browser/`.
+
+Prepare database once before you start:
+
+```bash
+# in folder backend/
+yarn run db:migrate init
+```
+
+Then clear and seed database:
+
+```bash
+# in folder backend/
+$ yarn run db:reset && db:seed
+```
+
+For a closer description see [backend README.md](./backend/README.md).
+For a full documentation see [SUMMARY](./SUMMARY.md).
+
+### Local Installation
+
+For a full documentation see [SUMMARY](./SUMMARY.md).
+
+## Contributing
+
+Choose an issue (consider our label [good-first-issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)) 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.
+
+We are happy if you fork our repository, but we don't recommend it for development. You do not need a fork.
+
+Clone this repository locally as [described above](#clone-the-repository), create your branch named `-`, add your code and push your branch to this repository. Then create a PR by comparing it to our `master`.
+
+Please run the following commands before you push:
+
+```bash
+# in folder backend/
+$ yarn lint --fix
+$ yarn test
+```
+
+```bash
+# in folder webapp/
+$ yarn lint --fix
+$ yarn locales --fix
+$ yarn test
+```
+
+Check out our [contribution guideline](./CONTRIBUTING.md), too!
+
+### Developer Chat
+
+Join our friendly open-source community on [Discord](https://discord.gg/AJSX9DCSUA) :heart_eyes_cat:
+Just introduce yourself at `#introduce-yourself` and mention a mentor or `@@Mentors` to get you onboard :neckbeard:
+
+We give write permissions to every developer who asks for it. Just text us on
+[Discord](https://discord.gg/AJSX9DCSUA).
## Deployment
Deployment methods can be found in the [Ocelot-Social-Deploy-Rebranding](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding) repository.
-The only deployment method in this repository is `docker-compose` for development purposes as described above.
-
-## Developer Chat
-
-Join our friendly open-source community on [Discord](https://discord.gg/AJSX9DCSUA) :heart_eyes_cat:
-Just introduce yourself at `#introduce-yourself` and mention `@@Mentor` to get you onboard :neckbeard:
-Check out the [contribution guideline](./CONTRIBUTING.md), too!
-
-We give write permissions to every developer who asks for it. Just text us on
-[Discord](https://discord.gg/AJSX9DCSUA).
+The only deployment method in this repository for development purposes as described above is `docker-compose`.
## Technology Stack
diff --git a/package.json b/package.json
index 1eef32b79..8e929d3c3 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "ocelot-social",
"version": "1.0.6",
- "description": "Fullstack and API tests with cypress and cucumber for ocelot.social",
+ "description": "Free and open source software program code available to run social networks.",
"author": "ocelot.social Community",
"license": "MIT",
"private": false,