diff --git a/README.md b/README.md index 9d657f98b..ab9ba0ef9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discord.gg/AJSX9DCSUA) [![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social) -[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. +[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.

@@ -18,27 +18,36 @@ Our goal is to enable people to participate fairly and equally in online social We therefore consider it desirable that operators offer such networks so that people can choose where they want to be on the move. -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. +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. + +If you would like to help set up this capability with us, please contact us. 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. ## Screenshots + Post feed + Check out more screenshots [here](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:Screenshots). ## Features -Ocelot.social networks feature: -* user accounts -* user roles -* posts and comments -* groups -* maps -* search -* filters -* and more … +Ocelot.social networks features: + +- **news feed** +- **posts** +- as **articles** and **events** +- **comments** +- **filter** +- **search** +- **groups** +- **map** +- **user accounts** +- **user roles** +- make your own **branded network** +- and more … Check out the [full feature list](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ#what-are-the-features). @@ -46,8 +55,8 @@ Check out the [full feature list](https://github.com/Ocelot-Social-Community/Oce In the [wiki](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki) you can find more information. -* [User Guide](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:User-Guide) -* [Frequently Asked Questions](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ) +- [User Guide](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:User-Guide) +- [Frequently Asked Questions](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ) ## Demo @@ -57,27 +66,28 @@ Try out our live demo network, see [here](#live-demo-and-developer-logins). If you're wondering how you could help, there are plenty of ways, e.g.: -* Spread the good word about ocelot.social to make it more popular: - * Add the link [ocelot.social](https://ocelot.social) to your website. - * Give ocelot.social a Like at https://alternativeto.net/software/ocelot-social/. - * Star our project on GitHub at https://github.com/Ocelot-Social-Community/Ocelot-Social/. - * Promote it on your social networks. - * Tell your friends about it by word-of-mouth. - * Write a press article on ocelot.social or contact the editorial office of your local newspage or radio station. -* Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though. -* Testing and [reporting](/issues/new/choose) bugs. -* Translating: Please [contact us](#contact). -* Reviewing and testing pull requests. +- Spread the good word about ocelot.social to make it more popular: + - Add the link [ocelot.social](https://ocelot.social) to your website. + - Give ocelot.social a Like at . + - Star our project on GitHub at . + - Promote it on your social networks. + - Tell your friends about it by word-of-mouth. + - Write a press article on ocelot.social or contact the editorial office of your local news page or radio station. +- Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though. +- Testing and [reporting](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/new/choose) bugs. +- Translating: Please [contact us](#contact). +- Reviewing and testing pull requests. -## Donate +## Donate -Your donation is very welcome and helps to enhance and improve the network. This software is mostly developped and maintained by the association [busFaktor() e.V.](https://www.busfaktor.org/en). Please support us with a [donation](https://www.busfaktor.org/en/donations) to busFaktor() e.V.. Thanks a lot! ❤️ +Your donation is very welcome and helps to enhance and improve the network. This software is mostly developed and maintained by the association [busFaktor() e.V.](https://www.busfaktor.org/en) . Please support us with a [donation](https://www.busfaktor.org/en/donations) to busFaktor() e.V. . Thanks a lot! ❤️ ## Contact Are you interested in operating your own ocelot.social network or becoming a user? Please contact us here: -* [hello@ocelot.social](mailto:hello@ocelot.social) -* [Discord](https://discord.com/invite/DFSjPaX) + +- [hello@ocelot.social](mailto:hello@ocelot.social) +- our developer chat on [Discord](https://discord.gg/AJSX9DCSUA) ## For Developers and Contributors @@ -90,17 +100,17 @@ Have a look into our short video: 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 -* [Cypress](./cypress) contains end-to-end tests and executable feature specifications +- [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 +- [Cypress](./cypress) contains end-to-end tests and executable feature specifications In order to setup the application and start to develop features you have to -setup **frontend** and **backend**. +setup **webapp** and **backend**. There are two approaches: 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. +2. **Or** install everything through [Docker](#docker-installation) which takes care of dependencies for you. ### Installation @@ -126,13 +136,13 @@ Change into the new folder. $ cd Ocelot-Social ``` -### Live Demo And Developer Logins +### Live Demo and Developer Logins **Try out our deployed [development environment](https://stage.ocelot.social).** Visit our staging networks: -* central staging network: [stage.ocelot.social](https://stage.ocelot.social) +- central staging network: [stage.ocelot.social](https://stage.ocelot.social) #### Login @@ -151,19 +161,14 @@ Docker is a software development container tool that combines software and its d ##### General Installation of Docker -There are [several ways to install Docker CE](https://docs.docker.com/install/) on your computer or server. - - * [install Docker Desktop on macOS](https://docs.docker.com/docker-for-mac/install/) - * [install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/) - * [install Docker CE on Linux](https://docs.docker.com/install/) +There are [several ways to install Docker](https://docs.docker.com/get-docker/) on your computer or server. Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions: ```bash +# use Docker version 24.0.6 or newer +# includes Docker Compose $ docker --version -Docker version 18.09.2 -$ docker-compose --version -docker-compose version 1.23.2 ``` ##### Start Ocelot-Social via Docker-Compose @@ -182,14 +187,14 @@ For Development: ```bash # in main folder -$ docker-compose up +$ docker compose up ``` For Production: ```bash # in main folder -$ docker-compose -f docker-compose.yml up +$ docker compose -f docker-compose.yml up ``` This will start all required Docker containers. @@ -198,7 +203,7 @@ Make sure your database is running on `http://localhost:7474/browser/`. Prepare database once before you start by running the following command in a second terminal: ```bash -# in main folder while docker-compose is up +# in main folder while docker compose is up $ docker compose exec backend yarn run db:migrate init $ docker compose exec backend yarn run db:migrate up ``` @@ -206,17 +211,17 @@ $ docker compose exec backend yarn run db:migrate up Then clear and seed database by running the following command as well in the second terminal: ```bash -# in main folder while docker-compose is up -$ docker-compose exec backend yarn run db:reset -$ docker-compose exec backend yarn run db:seed +# in main folder while docker compose is up +$ docker compose exec backend yarn run db:reset +$ docker compose exec backend yarn run db:seed ``` -For a closer description see [backend README.md](./backend/README.md). -For a full documentation see [SUMMARY](./SUMMARY.md). +For a closer description see [backend](./backend/README.md). +For a full documentation of the Docker installation see [summary](./SUMMARY.md). #### Local Installation -For a full documentation see [SUMMARY](./SUMMARY.md). +For a full documentation of the local installation see [summary](./SUMMARY.md). ### Contributing @@ -225,7 +230,9 @@ To have the necessary permission to push directly to this repository, please acc 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`. +Clone this repository locally as [described above](#clone-the-repository), create your branch named `-`, add your code and push your branch direct to this repository. Then create a PR by comparing it to our `master`. + +**_!!! Be aware:_** Please don't compare from a fork, because the tests are breaking caused by credential problems. Please run the following commands before you push: @@ -246,33 +253,48 @@ 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: +Join our friendly open-source community on [Discord](https://discord.gg/AJSX9DCSUA) 😻 +Just introduce yourself at `#introduce-yourself` and mention a mentor or `@@Mentors` to get you onboard 🤓 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. +Deployment methods can be found in our `deployment` folder described in the [README](./deployment/README.md). +Our branding template is our [stage.ocelot.social](https://github.com/Ocelot-Social-Community/stage.ocelot.social) repository. +Place your branding repository inside `deployment/configurations`. -The only deployment method in this repository for development purposes as described above is `docker-compose`. +The only deployment method in this repository for production purposes is [Kubernetes](https://kubernetes.io) for now. +But we just started to develop a deployment for [Docker Compose](https://docs.docker.com/compose/) as well. + +The only deployment method with branding in this repository for development purposes as described above is [Docker Compose](https://docs.docker.com/compose/): + +```bash +# in folder deployment/ +# set your branding folder name in .env +# then run +$ docker compose up +``` + +The code is branded automatically. +To setup the Neo4j database see above. ### Technology Stack -* [VueJS](https://vuejs.org/) -* [NuxtJS](https://nuxtjs.org/) -* [GraphQL](https://graphql.org/) -* [NodeJS](https://nodejs.org/en/) -* [Neo4J](https://neo4j.com/) +- [VueJS](https://vuejs.org/) +- [NuxtJS](https://nuxtjs.org/) +- [GraphQL](https://graphql.org/) +- [NodeJS](https://nodejs.org/en/) +- [Neo4J](https://neo4j.com/) #### For Testing -* [Cypress](https://docs.cypress.io/) -* [Storybook](https://storybook.js.org/) -* [Jest](https://jestjs.io/) -* [Vue Test Utils](https://vue-test-utils.vuejs.org/) -* [ESLint](https://eslint.org/) +- [Cypress](https://docs.cypress.io/) +- [Storybook](https://storybook.js.org/) +- [Jest](https://jestjs.io/) +- [Vue Test Utils](https://vue-test-utils.vuejs.org/) +- [ESLint](https://eslint.org/) ### Attributions @@ -280,7 +302,9 @@ Locale Icons made by [Freepik](http://www.freepik.com/) from [www.flaticon.com]( Browser compatibility testing with [BrowserStack](https://www.browserstack.com/). + BrowserStack Logo + ### License diff --git a/SUMMARY.md b/SUMMARY.md index 453a809b4..097da9986 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,19 +6,17 @@ * [Backend](backend/README.md) * [GraphQL](backend/graphql.md) * [neo4j-graphql-js](backend/neo4j-graphql-js.md) -* [Webapp](webapp/README.md) +* [Webapp (Frontend)](webapp/README.md) * [Components](webapp/components.md) * [HTML](webapp/html.md) * [SCSS](webapp/scss.md) * [Vue](webapp/vue.md) * [Testing Guide](testing.md) - * [End-to-end tests](cypress/README.md) - * [Frontend tests](webapp/testing.md) - * [Backend tests](backend/testing.md) -* [Docker More Closely](DOCKER_MORE_CLOSELY.md) + * [End-to-end Tests](cypress/README.md) + * [Webapp (Frontend) Tests](webapp/testing.md) + * [Backend Tests](backend/testing.md) * [Deployment](deployment/README.md) * [Contributing](CONTRIBUTING.md) * [Feature Specification](cypress/features.md) -* [Code of conduct](CODE_OF_CONDUCT.md) +* [Code of Conduct](CODE_OF_CONDUCT.md) * [License](LICENSE.md) - diff --git a/backend/graphql.md b/backend/graphql.md index 12cc59e57..f49edb3b8 100644 --- a/backend/graphql.md +++ b/backend/graphql.md @@ -2,12 +2,13 @@ GraphQL is a data query language which provides an alternative to REST and ad-hoc web service architectures. It allows clients to define the structure of the data required, and exactly the same structure of the data is returned from the server. -![GraphQL Playground](../../../.gitbook/assets/graphql-playground%20%281%29.png) +We have a closer description for the [GraphQL Playground](./src/graphql/GraphQL-Playground.md). + +![GraphQL Playground](../.gitbook/assets/graphql-playground%20%281%29.png) ## Middleware keeps resolvers clean -![](../.gitbook/assets/grafik-4.png) - +![Middleware schema](../.gitbook/assets/grafik-4.png) A well-organized codebase is key for the ability to maintain and easily introduce changes into an app. Figuring out the right structure for your code remains a continuous challenge - especially as an application grows and more developers are joining a project. diff --git a/backend/src/graphql/GraphQL-Playground.md b/backend/src/graphql/GraphQL-Playground.md index 33e371eb5..e914ea993 100644 --- a/backend/src/graphql/GraphQL-Playground.md +++ b/backend/src/graphql/GraphQL-Playground.md @@ -1,5 +1,7 @@ # GraphQL Playground +![GraphQL Playground](../../../.gitbook/assets/graphql-playground%20%281%29.png) + ***Attention:** For using the GraphQL Playground set `DEBUG=true` in your backend `.env`, see `.env.template`!* To use GraphQL Playground, we need to know some basics: diff --git a/backend/testing.md b/backend/testing.md index 600973450..a246569e5 100644 --- a/backend/testing.md +++ b/backend/testing.md @@ -1,2 +1,3 @@ # Unit Testing +***TODO:** To be filled in* diff --git a/edit-this-documentation.md b/edit-this-documentation.md index c841b09ca..5353688bd 100644 --- a/edit-this-documentation.md +++ b/edit-this-documentation.md @@ -2,13 +2,13 @@ Find the [**table of contents** for this documentation on GitHub](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/SUMMARY.md) and navigate to the file you need to update. -Click on the **edit pencil** on the right side directly above the text to edit this file on your fork of Human Connection \(HC\). +Click on the **edit pencil** on the right side directly above the text to edit this file in our repository. You can see a preview of your changes by clicking the **Preview changes** tab aside the **Edit file** tab. If you are ready, fill in the **Propose file change** at the end of the webpage. -After that you have to send your change to the HC basis with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our [open issues](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) please include the number.) +After that you have to compare your change branch to our `master` branch with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our [open issues](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) please include the number.) ## Markdown your documentation @@ -21,9 +21,9 @@ To design your documentation see the syntax description at GitBook: #### Headlines ```markdown -# Main headline -## Smaller headlines -### Small headlines +# Main Headline +## Smaller Headlines +### Small Headlines ``` #### Tabs @@ -60,15 +60,15 @@ XXX ![XXX](https://XXX) ``` -#### Hints For ToDos +#### Hints for ToDos ```markdown {% hint style="info" %} TODO: XXX {% endhint %} ``` -## Host The Screenshots +## Host the Screenshots -### Host On Ocelot-Social \(GitHub\) repository +### Host on Ocelot-Social \(GitHub\) Repository {% hint style="info" %} TODO: How to host on Ocelot-Social \(GitHub\) repository ... @@ -88,12 +88,13 @@ Right click on it and choose kind of **Open link in new tab**. Copy the URL and paste it were you need it. -## Screenshot modification +## Screenshot Modification -### Add an arrow or some other marking stuff +### Add an Arrow or some other Marking Stuff {% tabs %} {% tab title="macOS" %} + #### In the Preview App Got to: **Menu** + **Tools** \(GER: Werkzeuge\) + **Annotate** \(GER: Anmerkungen\) + etc.