lib.itmens/README.md

58 lines
2.5 KiB
Markdown
Raw Normal View History

2022-12-13 16:33:58 -05:00
# Boofilsic/NeoDB
2022-12-16 12:15:32 -05:00
![Test Status](https://github.com/neodb-social/neodb/actions/workflows/django.yml/badge.svg?branch=main)
2023-01-23 17:35:52 -05:00
Boofilsic/NeoDB 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
2022-12-13 16:33:58 -05:00
[NeoDB.social](https://neodb.social) and [NiceDB](https://nicedb.org) are free services hosted by volunteers.
2021-10-29 10:58:10 +02:00
2023-02-17 07:58:03 -05:00
## Features
- 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
* Bandcamp
* Steam
* IGDB
* Bangumi
* 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
* Douban archive (via Doufen)
- 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
+ link Fediverse account and import social graph
+ share collections and reviews to Fediverse ~~and Twitter~~ feed
+ there's a plan to add ActivityPub support in the near future
2022-07-31 21:02:03 -04:00
## Install
2022-12-13 16:33:58 -05:00
Please see [doc/install.md](doc/install.md)
2022-07-31 21:02:03 -04:00
2022-08-05 14:23:24 -04:00
## Bug Report
- to file a bug for NiceDB, please create an issue [here](https://github.com/doubaniux/boofilsic/issues/new)
- to file a bug or request new features for NeoDB, please contact NeoDB on [Fediverse](https://mastodon.social/@neodb) or [Twitter](https://twitter.com/NeoDBsocial)
2021-10-29 10:58:10 +02:00
## Contribution
2022-12-13 16:33:58 -05:00
- Please see [doc/development.md](doc/development.md) for some basics to start with
- Join our Discord community, links available on [our Fediverse profile](https://mastodon.social/@neodb)
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
- NeoDB on [ko-fi](https://ko-fi.com/neodb) or [liberapay](https://liberapay.com/neodb)
- NiceDB on [Patreon](https://patreon.com/tertius).