{"id":13614198,"url":"https://github.com/Ocelot-Social-Community/Ocelot-Social","last_synced_at":"2025-04-13T18:32:40.694Z","repository":{"id":36973974,"uuid":"301151089","full_name":"Ocelot-Social-Community/Ocelot-Social","owner":"Ocelot-Social-Community","description":"Free and open-source social network for active citizenship.","archived":false,"fork":false,"pushed_at":"2024-11-05T12:30:33.000Z","size":112587,"stargazers_count":95,"open_issues_count":603,"forks_count":38,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-05T13:20:05.851Z","etag":null,"topics":["activitypub","apollo","cypress","docker","docker-compose","fediverse","graphql","helm","jest-tests","neo4j","neo4j-database","node","nodejs","nuxt","nuxtjs","social-media","social-network","storybook","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://ocelot.social","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ocelot-Social-Community.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-04T14:37:59.000Z","updated_at":"2024-11-03T18:15:37.000Z","dependencies_parsed_at":"2024-02-05T17:52:41.493Z","dependency_job_id":"e014d558-db7e-43a7-9a5c-2052cd0dc761","html_url":"https://github.com/Ocelot-Social-Community/Ocelot-Social","commit_stats":{"total_commits":10766,"total_committers":100,"mean_commits":107.66,"dds":0.8423741408136727,"last_synced_commit":"026c5a02ec4311e1c800615b514d69e0893223ca"},"previous_names":[],"tags_count":883,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ocelot-Social-Community%2FOcelot-Social","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ocelot-Social-Community%2FOcelot-Social/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ocelot-Social-Community%2FOcelot-Social/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ocelot-Social-Community%2FOcelot-Social/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ocelot-Social-Community","download_url":"https://codeload.github.com/Ocelot-Social-Community/Ocelot-Social/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223362248,"owners_count":17133066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["activitypub","apollo","cypress","docker","docker-compose","fediverse","graphql","helm","jest-tests","neo4j","neo4j-database","node","nodejs","nuxt","nuxtjs","social-media","social-network","storybook","vue","vuejs"],"created_at":"2024-08-01T20:00:58.273Z","updated_at":"2024-11-07T22:30:56.939Z","avatar_url":"https://github.com/Ocelot-Social-Community.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Ocelot.Social\n\n[![Backend Test CI](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml/badge.svg?branch=master)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-backend.yml)\n[![Webapp Test CI](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml/badge.svg?branch=master)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-webapp.yml)\n[![E2E Test CI](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml/badge.svg?branch=master)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test-e2e.yml)\n[![Build Status Publish](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/publish.yml/badge.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions)\n[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/LICENSE.md)\n[![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discord.gg/AJSX9DCSUA)\n[![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social)\n\n[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.\n\n\u003c!-- markdownlint-disable MD033 --\u003e\n\u003c!-- \u003cp align=\"center\"\u003e --\u003e\n\u003cp style=\"text-align: center;\"\u003e\n  \u003ca href=\"https://ocelot.social\" target=\"_blank\"\u003e\u003cimg 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%\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003c!-- markdownlint-enable MD033 --\u003e\n\nOur 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.\n\nWe therefore consider it desirable that operators offer such networks so that people can choose where they want to be on the move.\n\nOur 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.\n\nIf you would like to help set up this capability with us, please contact us.\n\nIn 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.\n\n## Screenshots\n\n\u003c!-- markdownlint-disable MD033 --\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/17728384/218597429-554e4082-3906-4721-8f68-0c13146fc218.png\" alt=\"Post feed\" title=\"Post feed\" /\u003e\n\u003c!-- markdownlint-enable MD033 --\u003e\n\nCheck out more screenshots [here](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:Screenshots).\n\n## Features\n\nOcelot.social networks features:\n\n- **news feed**\n- **posts**\n- as **articles** and **events**\n- **comments**\n- **filter**\n- **search**\n- **groups**\n- **map**\n- **user accounts**\n- **user roles**\n- make your own **branded network**\n- and more …\n\nCheck out the [full feature list](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ#what-are-the-features).\n\n## User Guide and Frequently Asked Questions\n\nIn the [wiki](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki) you can find more information.\n\n- [User Guide](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:User-Guide)\n- [Frequently Asked Questions](https://github.com/Ocelot-Social-Community/Ocelot-Social/wiki/en:FAQ)\n\n## Demo\n\nTry out our live demo network, see [here](#live-demo-and-developer-logins).\n\n## Help us\n\nIf you're wondering how you could help, there are plenty of ways, e.g.:\n\n- Spread the good word about ocelot.social to make it more popular:\n  - Add the link [ocelot.social](https://ocelot.social) to your website.\n  - Give ocelot.social a Like at \u003chttps://alternativeto.net/software/ocelot-social/\u003e.\n  - Star our project on GitHub at \u003chttps://github.com/Ocelot-Social-Community/Ocelot-Social/\u003e.\n  - Promote it on your social networks.\n  - Tell your friends about it by word-of-mouth.\n  - Write a press article on ocelot.social or contact the editorial office of your local news page or radio station.\n- 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.\n- Testing and [reporting](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/new/choose) bugs.\n- Translating: Please [contact us](#contact).\n- Reviewing and testing pull requests.\n\n## Donate\n\nYour 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! ❤️\n\n## Contact\n\nAre you interested in operating your own ocelot.social network or becoming a user? Please contact us here:\n\n- [hello@ocelot.social](mailto:hello@ocelot.social)\n- our developer chat on [Discord](https://discord.gg/AJSX9DCSUA)\n\n## For Developers and Contributors\n\n### Introduction\n\nHave a look into our short video:\n[ocelot.social - GitHub - Developer Welcome - Tutorial (english)](https://www.youtube.com/watch?v=gZSL6KvBIiY\u0026list=PLFMD5liPP01kbuReHxYXxv_1fI5rIgS1f\u0026index=1)\n\n### Directory Layout\n\nThere are three important directories:\n\n- [Backend](./backend) runs on the server and is a middleware between database and frontend\n- [Frontend](./webapp) is a server-side-rendered and client-side-rendered web frontend\n- [Cypress](./cypress) contains end-to-end tests and executable feature specifications\n\nIn order to setup the application and start to develop features you have to\nsetup **webapp** and **backend**.\n\nThere are two approaches:\n\n1. [Local](#local-installation) installation, which means you have to take care of dependencies yourself.\n2. **Or** install everything through [Docker](#docker-installation) which takes care of dependencies for you.\n\n### Installation\n\n#### Clone the Repository\n\nClone the repository, this will create a new folder called `Ocelot-Social`:\n\nUsing HTTPS:\n\n```bash\n$ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git\n```\n\nUsing SSH:\n\n```bash\n$ git clone git@github.com:Ocelot-Social-Community/Ocelot-Social.git\n```\n\nChange into the new folder.\n\n```bash\n$ cd Ocelot-Social\n```\n\n### Live Demo and Developer Logins\n\n**Try out our deployed [development environment](https://stage.ocelot.social).**\n\nVisit our staging networks:\n\n- central staging network: [stage.ocelot.social](https://stage.ocelot.social)\n\u003c!-- - rebranded staging network: [rebrand.ocelot.social](https://stage.ocelot.social). --\u003e\n\n#### Login\n\nLogins for the live demos and developers (local developers after the following installations) in the browser:\n\n| email | password | role |\n| :--- | :--- | :--- |\n| `user@example.org` | 1234 | user |\n| `moderator@example.org` | 1234 | moderator |\n| `admin@example.org` | 1234 | admin |\n\n#### Docker Installation\n\nDocker 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.\n\n##### General Installation of Docker\n\nThere are [several ways to install Docker](https://docs.docker.com/get-docker/) on your computer or server.\n\nCheck the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:\n\n```bash\n# use Docker version 24.0.6 or newer\n# includes Docker Compose\n$ docker --version\n```\n\n##### Start Ocelot-Social via Docker Compose\n\n***ATTENTION:** For using Docker commands in Apple Silicon environments see [here](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md#apple-silicon-platform).*\n\nPrepare ENVs once beforehand:\n\n```bash\n# in folder webapp/\n$ cp .env.template .env\n\n# in folder backend/\n$ cp .env.template .env\n```\n\nFor Development:\n\n```bash\n# in main folder\n$ docker compose up\n```\n\nFor Production:\n\n```bash\n# in main folder\n$ docker compose -f docker-compose.yml up\n```\n\nThis will start all required Docker containers.  \nMake sure your database is running on `http://localhost:7474/browser/`.\n\nPrepare database once before you start by running the following command in a second terminal:\n\n```bash\n# in main folder while docker compose is up\n$ docker compose exec backend yarn run db:migrate init\n$ docker compose exec backend yarn run db:migrate up\n```\n\nThen clear and seed database by running the following command as well in the second terminal:\n\n```bash\n# in main folder while docker compose is up\n$ docker compose exec backend yarn run db:reset\n$ docker compose exec backend yarn run db:seed\n```\n\nFor a closer description see [backend](./backend/README.md).  \nFor a full documentation of the Docker installation see [summary](./SUMMARY.md).\n\n#### Local Installation\n\nFor a full documentation of the local installation see [summary](./SUMMARY.md).\n\n### Contributing\n\nChoose 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.\nTo 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.\n\nWe are happy if you fork our repository, but we don't recommend it for development. You do not need a fork.\n\nClone this repository locally as [described above](#clone-the-repository), create your branch named `\u003cissue-number\u003e-\u003cdescription\u003e`, add your code and push your branch direct to this repository. Then create a PR by comparing it to our `master`.\n\n***!!! Be aware:*** Please don't compare from a fork, because the tests are breaking caused by credential problems.\n\nPlease run the following commands before you push:\n\n```bash\n# in folder backend/\n$ yarn lint --fix\n$ yarn test\n```\n\n```bash\n# in folder webapp/\n$ yarn lint --fix\n$ yarn locales --fix\n$ yarn test\n```\n\nCheck out our [contribution guideline](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md), too!\n\n#### Developer Chat\n\nJoin our friendly open-source community on [Discord](https://discord.gg/AJSX9DCSUA) 😻\nJust introduce yourself at `#introduce-yourself` and mention a mentor or `@@Mentors` to get you onboard 🤓\n\nWe give write permissions to every developer who asks for it. Just text us on\n[Discord](https://discord.gg/AJSX9DCSUA).\n\n### Deployment\n\nDeployment methods can be found in our `deployment` folder described in the [README](./deployment/README.md).\nOur branding template is our [stage.ocelot.social](https://github.com/Ocelot-Social-Community/stage.ocelot.social) repository.\nPlace your branding repository inside `deployment/configurations`.\n\nThe only deployment method in this repository for production purposes is [Kubernetes](https://kubernetes.io) for now.\nBut we just started to develop a deployment for [Docker Compose](https://docs.docker.com/compose/) as well.\n\nThe only deployment method with branding in this repository for development purposes as described above is [Docker Compose](https://docs.docker.com/compose/):\n\n```bash\n# in folder deployment/\n# set your branding folder name in .env\n# then run\n$ docker compose up\n```\n\nThe code is branded automatically.\nTo setup the Neo4j database see above.\n\n### Technology Stack\n\n- [VueJS](https://vuejs.org/)\n- [NuxtJS](https://nuxtjs.org/)\n- [GraphQL](https://graphql.org/)\n- [NodeJS](https://nodejs.org/en/)\n- [Neo4J](https://neo4j.com/)\n\n#### For Testing\n\n- [Cypress](https://docs.cypress.io/)\n- [Storybook](https://storybook.js.org/)\n- [Jest](https://jestjs.io/)\n- [Vue Test Utils](https://vue-test-utils.vuejs.org/)\n- [ESLint](https://eslint.org/)\n\n### Attributions\n\nLocale Icons made by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).\n\nBrowser compatibility testing with [BrowserStack](https://www.browserstack.com/).\n\n\u003c!-- markdownlint-disable MD033 --\u003e\n\u003cimg alt=\"BrowserStack Logo\" src=\"https://raw.githubusercontent.com/Ocelot-Social-Community/Ocelot-Social/master/.gitbook/assets/browserstack-logo.svg\" width=\"256\"\u003e\n\u003c!-- markdownlint-enable MD033 --\u003e\n\n### License\n\nSee the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOcelot-Social-Community%2FOcelot-Social","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOcelot-Social-Community%2FOcelot-Social","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOcelot-Social-Community%2FOcelot-Social/lists"}