summaryrefslogtreecommitdiffstats
path: root/README.md
blob: a4ddd34100daabd7cb08d2d9b5251f70f96066ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Nextcloud Social

**πŸŽ‰ Nextcloud becomes part of the federated social networks!**

⚠️ **This application is currently in beta stage.**

![](img/screenshot.png)

- **πŸ™‹ Find your friends:** No matter if they use [☁ Nextcloud Social](https://github.com/nextcloud/social#nextcloud-social), [🐘 Mastodon](https://joinmastodon.org), [πŸ…ΏοΈ Pleroma](https://pleroma.social) and soon [πŸ“Ί PeerTube](https://joinpeertube.org) or [πŸ“· PixelFed](https://pixelfed.org) – you can follow them!
- **πŸ“œ Profile info:** No need to fill out more profiles – your info from Nextcloud will be used and extended.
- **πŸ‘ Own your posts:** Everything you post stays on your Nextcloud!
- **πŸ•Έ Open standards:** We use the established [ActivityPub](https://en.wikipedia.org/wiki/ActivityPub) standard!
- **🎨 Nice illustrations:** Made by [Katerina Limpitsouni of unDraw](https://undraw.co).

For more information about our motivation and goals, read [the announcement blog.](https://nextcloud.com/blog/nextcloud-introduces-social-features-joins-the-fediverse/)

The app is in beta stage, so it’s time for you to [get involved! πŸ‘©β€πŸ’»](https://github.com/nextcloud/social#development-setup)

For a roadmap, see our [development milestones](https://github.com/nextcloud/social/milestones) - feel free to pick up any of the tasks which are not yet in progress!

## Emojis

Please follow [this guide](https://docs.nextcloud.com/server/stable/admin_manual/configuration_database/mysql_4byte_support.html) to enable the Emojis in the Social app.

## Reset app

If you want to reset all Social app data e.g. to change the domain used for Social, you can use `occ social:reset` (For how to use occ commands see documentation: [using the occ command](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html)).


## Development setup

1. ☁ Clone the app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/social.git`
2. πŸ‘©β€πŸ’» Run `make dev-setup` to install the dependencies
3. πŸ— To build the Javascript whenever you make changes, run `make build-js`
4. βœ… Enable the app through the app management of your Nextcloud
5. πŸŽ‰ Partytime! Help fix [some issues](https://github.com/nextcloud/social/issues) and [review pull requests](https://github.com/nextcloud/social/pulls) πŸ‘

![](img/social-promo.png)