diff --git a/README.md b/README.md index 2062865dd..73e26deb3 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,19 @@ Check out more screenshots [here](/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** +- and more … Check out the [full feature list](/wiki/en:FAQ#what-are-the-features). @@ -46,8 +50,8 @@ Check out the [full feature list](/wiki/en:FAQ#what-are-the-features). In the [wiki](/wiki) you can find more information. -* [User Guide](/wiki/en:User-Guide) -* [Frequently Asked Questions](/wiki/en:FAQ) +- [User Guide](/wiki/en:User-Guide) +- [Frequently Asked Questions](/wiki/en:FAQ) ## Demo @@ -57,27 +61,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.com/invite/DFSjPaX) ## For Developers and Contributors @@ -90,17 +95,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,7 +131,7 @@ 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).** @@ -151,19 +156,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 +182,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 +198,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 +206,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