lib.itmens/README.md

80 lines
4.6 KiB
Markdown
Raw Normal View History

2024-05-09 07:00:45 -04:00
![Tests](https://img.shields.io/github/actions/workflow/status/neodb-social/neodb/tests.yml?style=for-the-badge&color=56AA54&label=tests)
2024-10-23 16:43:35 -04:00
[![Translation](https://img.shields.io/weblate/progress/neodb?style=for-the-badge)](https://hosted.weblate.org/projects/neodb/neodb/)
2024-05-13 17:41:00 -04:00
[![GitHub Release](https://img.shields.io/github/v/release/neodb-social/neodb?style=for-the-badge&color=3791E0&logoColor=fff)](https://github.com/neodb-social/neodb/releases)
[![Docker Pulls](https://img.shields.io/docker/pulls/neodb/neodb?label=docker&color=3791E0&style=for-the-badge)](https://hub.docker.com/r/neodb/neodb)
[![GitHub License](https://img.shields.io/github/license/neodb-social/neodb?color=E69A48&style=for-the-badge)](https://github.com/neodb-social/neodb/blob/main/LICENSE)
2024-05-09 07:00:45 -04:00
2024-01-20 10:48:15 -05:00
# 🧩 NeoDB
2024-05-28 10:28:18 -04:00
_mark the things you love._
2022-12-16 12:15:32 -05:00
2024-06-05 21:53:02 -04:00
[NeoDB](https://neodb.net) (fka boofilsic) is an open source project and free service to help users manage, share and discover collections, reviews and ratings for culture products (e.g. books, movies, music, podcasts, games and performances) in Fediverse.
2021-10-29 10:58:10 +02:00
2024-01-20 10:48:15 -05:00
[NeoDB.social](https://neodb.social) and [NiceDB](https://nicedb.org) are free instances hosted by volunteers. Your support is essential to keep these services free and open-sourced.
2023-08-20 12:44:20 -04:00
2024-11-27 20:31:14 -05:00
Follow us on [Fediverse](https://mastodon.online/@neodb), [Bluesky](https://bsky.app/profile/neodb.net) or join our [Discord community](https://discord.gg/QBHkrV8bxK) to share your ideas/questions/creations
2024-05-09 07:00:45 -04:00
[![Mastodon](https://img.shields.io/mastodon/follow/106919732872456302?style=for-the-badge&logo=mastodon&logoColor=fff&label=%40neodb%40mastodon.social&color=6D75D2)](https://mastodon.social/@neodb)
2024-11-27 20:31:14 -05:00
[![Discord](https://img.shields.io/discord/1041738638364528710?label=Discord&logo=discord&logoColor=fff&color=6D75D2&style=for-the-badge)](https://discord.gg/QBHkrV8bxK)
[![Kofi](https://img.shields.io/badge/Ko--Fi-Donate-orange?label=Support%20NeoDB%20on%20Ko-fi&style=for-the-badge&color=ff5f5f&logo=ko-fi)](https://ko-fi.com/neodb)
2021-10-29 10:58:10 +02:00
2023-02-17 07:58:03 -05:00
## Features
2023-11-19 13:39:43 -05:00
- Manage a shared catalog of books/movies/tv shows/music album/games/podcasts/performances
+ search or create catalog items in each category
+ one click create item with links to 3rd party sites:
* Goodreads
* IMDB
* The Movie Database
* Douban
* Google Books
* Discogs
* Spotify
* Apple Music
* Bandcamp
* Steam
* IGDB
* Bangumi
2024-01-20 02:00:30 -05:00
* Board Game Geek
2023-11-19 13:39:43 -05:00
* any RSS link to a podcast
- Logged in users can manage their collections:
+ mark an item as wishlist/in progress/complete
+ rate and write reviews for an item
+ create tags for an item, either privately or publicly
+ create and share list of items
+ tracking progress of a list (e.g. personal reading challenges)
+ Import and export full user data archive
+ import list or archives from some 3rd party sites:
* Goodreads reading list
2024-01-20 02:00:30 -05:00
* Letterboxd watch list
* Douban archive (via [Doufen](https://doufen.org/))
2023-11-19 13:39:43 -05:00
- Social features:
+ view home feed with friends' activities
* every activity can be set as viewable to self/follower-only/public
* eligible items, e.g. podcasts and albums, are playable in feed
+ login with other Fediverse identity and import social graph
2023-11-19 13:39:43 -05:00
* supported servers: Mastodon/Pleroma/Firefish/GoToSocial/Pixelfed/friendica/Takahē
+ login with Bluesky / ATProto identity and import social graph
+ login with threads.net (requires app verification by Meta)
+ share collections and reviews to Fediverse/Bluesky/Threads
2024-05-09 07:00:45 -04:00
- ActivityPub support
+ NeoDB users can follow and interact with users on other ActivityPub services like Mastodon and Pleroma
+ NeoDB instances communicate with each other via an extended version of ActivityPub
+ NeoDB instances may share public rating and reviews with a default relay
+ implementation is based on [Takahē](https://jointakahe.org/) server
2024-10-23 16:43:35 -04:00
- ATProto support
+ NeoDB is not a PDS, but may publish posts to user feed
2023-11-19 13:39:43 -05:00
- Other
2024-10-23 16:43:35 -04:00
+ i18n: English, Danish and Simp/Trad Chinese available; contribution for more languages welcomed
2023-02-17 07:58:03 -05:00
2024-05-09 07:00:45 -04:00
## Host your own instance
2024-06-05 21:53:02 -04:00
Please see [docs/install.md](docs/install.md)
2022-07-31 21:02:03 -04:00
2021-10-29 10:58:10 +02:00
## Contribution
2023-06-03 01:22:19 -04:00
- To build application with NeoDB API, documentation is available in [NeoDB API Developer Console](https://neodb.social/developer/)
2024-06-05 21:53:02 -04:00
- To help develop NeoDB, please see [docs/development.md](docs/development.md) for some basics to start with
2024-10-23 16:43:35 -04:00
- To translate NeoDB to more languages, please join [our project on Weblate](https://hosted.weblate.org/projects/neodb/neodb/)
2024-05-09 07:00:45 -04:00
2021-10-29 10:58:10 +02:00
## Sponsor
2023-01-23 17:35:52 -05:00
If you like this project, please consider sponsoring
2024-01-20 02:00:30 -05:00
- NeoDB on [ko-fi](https://ko-fi.com/neodb)
2023-01-23 17:35:52 -05:00
- NiceDB on [Patreon](https://patreon.com/tertius).