nulla/README.md

Nulla

An agnostic social network following the KISS and UNIX philosophy, the main principles of which are minimalism and rationalism. It implements the ActivityPub protocol and promises maximum compatibility with all existing implementations.

TODO

API

accounts

• POST /api/v1/accounts
• GET /api/v1/accounts/verify_credentials
• PATCH /api/v1/accounts/update_credentials
• GET /api/v1/accounts/:id
• GET /api/v1/accounts
• GET /api/v1/accounts/:id/notes
• GET /api/v1/accounts/:id/followers
• GET /api/v1/accounts/:id/following
• GET /api/v1/accounts/:id/featured_tags
• GET /api/v1/accounts/:id/lists
• POST /api/v1/accounts/:id/follow
• POST /api/v1/accounts/:id/unfollow
• POST /api/v1/accounts/:id/remove_from_followers
• POST /api/v1/accounts/:id/block
• POST /api/v1/accounts/:id/unblock
• POST /api/v1/accounts/:id/mute
• POST /api/v1/accounts/:id/unmute
• GET /api/v1/accounts/:id/endorsements
• POST /api/v1/accounts/:id/endorse
• POST /api/v1/accounts/:id/unendorse
• POST /api/v1/accounts/:id/note
• GET /api/v1/accounts/relationships
• GET /api/v1/accounts/familiar_followers
• GET /api/v1/accounts/search
• GET /api/v1/accounts/lookup

announcements

• GET /api/v1/announcements
• POST /api/v1/announcements/:id/dismiss
• PUT /api/v1/announcements/:id/reactions/:name
• DELETE /api/v1/announcements/:id/reactions/:name

blocks

• GET /api/v1/blocks

bookmarks

• GET /api/v1/bookmarks

conversations

• GET /api/v1/conversations
• DELETE /api/v1/conversations/:id
• POST /api/v1/conversations/:id/read

custom_emojis

• GET /api/v1/custom_emojis

directory

• GET /api/v1/directory

domain_blocks

• GET /api/v1/domain_blocks
• POST /api/v1/domain_blocks
• POST /api/v1/domain_blocks

emails

• POST /api/v1/emails/confirmations

endorsements

• GET /api/v1/endorsements

favourites

• GET /api/v1/favourites

featured_tags

• GET /api/v1/featured_tags
• POST /api/v1/featured_tags
• GET /api/v1/featured_tags/:id
• GET /api/v1/featured_tags/suggestions

filters

• GET /api/v2/filters
• GET /api/v2/filters/:id
• POST /api/v2/filters
• PUT /api/v2/filters/:id
• DELETE /api/v2/filters/:id
• GET /api/v2/filters/:filter_id/keywords
• POST /api/v2/filters/:filter_id/keywords
• GET /api/v2/filters/keywords/:id
• PUT /api/v2/filters/keywords/:id
• DELETE /api/v2/filters/keywords/:id
• GET /api/v2/filters/:filter_id/notes
• POST /api/v2/filters/:filter_id/notes
• GET /api/v2/filters/notes/:id
• DELETE /api/v2/filters/notes/:id

follow_requests

• GET /api/v1/follow_requests
• POST /api/v1/follow_requests/:account_id/authorize
• POST /api/v1/follow_requests/:account_id/reject

followed_tags

• GET /api/v1/followed_tags

grouped_notifications

• GET /api/v2/notifications
• GET /api/v2/notifications/:group_key
• POST /api/v2/notifications/:group_key/dismiss
• GET /api/v2/notifications/:group_key/accounts
• GET /api/v2/notifications/unread_count

instance

• GET /api/v2/instance
• GET /api/v2/instance/peers
• GET /api/v2/instance/activity
• GET /api/v2/instance/rules
• GET /api/v2/instance/domain_blocks
• GET /api/v2/instance/extended_description
• GET /api/v2/instance/privacy_policy
• GET /api/v2/instance/terms_of_service
• GET /api/v2/instance/terms_of_service/:date
• GET /api/v2/instance/translation_languages

lists

• GET /api/v1/lists
• GET /api/v1/lists/:id
• POST /api/v1/lists
• PUT /api/v1/lists/:id
• DELETE /api/v1/lists/:id
• GET /api/v1/lists/:id/accounts
• POST /api/v1/lists/:id/accounts
• DELETE /api/v1/lists/:id/accounts

Features

• Lightweight web interface
• API compatible with other ActivityPub instances
• JWT
• Groups
• Formatting: big/medium/small title, bold, italic, strikethrough, link, code, code block
• Links preview
• Timelines: Home / Local / Global / Custom
• Global search
• Bookmarks
• Profile links verification
• Links preview
• Import/Export posts
• Sync user settings on the server
• Restricted direct messages
• Direct messages tab

Server configuration

• Disk space limit per user
• Limit on posts (count/time)

User settings

Profile

• Avatar
• Banner
• Name
• Bio
• Location
• Birthday
• Links
• Follow requests approval
• Toggle reacts under own posts
• Toggle view of reacts under posts
• Profile migration
• Delete account

===== Disk Usage: 100 MB (20%) =====

Security

• Change password
• Token
• Enable/Disable email login notifications
• Sessions

IP	Datetime	Action
127.0.0.1	2025-01-01 00:00:00	revoke
127.127.127.127	2025-02-02 00:00:00	revoke

Filters

• Placeholder with rules

filter keyword #tag user@example.com example.com

• Show replies of all followed users
• Show replies of this followed users

Contributing

Patches via Email

You can create a patch with this command git format-patch -M origin/main and send it to this email address. Check out this guide.

Your repository

You fork this repository and make your changes in the feature branch, then I pull it.