https://github.com/alyxshang/kleah
A federated social platform for ancient creatures. :swan: :black_heart: (W.I.P.)
https://github.com/alyxshang/kleah
activitypub fediverse rust-lang
Last synced: 2 months ago
JSON representation
A federated social platform for ancient creatures. :swan: :black_heart: (W.I.P.)
- Host: GitHub
- URL: https://github.com/alyxshang/kleah
- Owner: alyxshang
- License: other
- Created: 2024-12-26T21:16:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-07T20:34:11.000Z (4 months ago)
- Last Synced: 2025-01-07T21:30:23.450Z (4 months ago)
- Topics: activitypub, fediverse, rust-lang
- Language: Rust
- Homepage: https://kleah.social/
- Size: 60.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE
Awesome Lists containing this project
README
# KLEAH :swan: :black_heart:
***A federated social platform for ancient creatures. :swan: :black_heart: (W.I.P.)***
## ABOUT :books:
This repository contains the source code for ***Kleah***. is The backend is an API service written in Rust using [Actix Web](https://actix.rs/) and [SQLx](https://github.com/launchbadge/sqlx). The frontend is written in Typescript using [Deno](https://deno.land) and [Fresh](https://fresh.deno.dev).
## STATUS :warning:
***THIS PROJECT IS STILL HEAVILY WORK IN PROGRESS.***
## TO DO :gear:
## Backend
- [ ] REST API routes.
- [ ] Adding Federation.
- [ ] User file privacy.
- [ ] REST API documentation.
- [ ] Instance-specific reactions.
- [ ] Unit testing for whatever possible.
- [x] Add the admin users.
- [x] Rust API documentation.
- [x] Leanify the Docker image.
- [x] Adding a follower system.
- [x] User profile picture upload.
- [x] Invite codes for admin users.
- [x] Add a system for blocking users.
- [x] Adding API routes for a frontend.
- [x] Add a system for following users.
- [x] Add E-Mail verification at signup.
- [x] Add a system for liking user posts.
- [x] Add the possibility for adding themes.
- [x] Instance-specific rules for admin users.
- [x] Instance information with description for admin users.
- [x] Add the possibility for admins to update instance info.
- [x] Instance information with Kleah version for admin users.
- [x] Add the possibility for users to update their information.
- [x] Change Moods to Charms (turn this into a micro-blogging platform)
## Frontend
- [ ] Add a frontend.
- [ ] Add a feature list.
- [ ] Unit tests for a frontend.
## THE TOME :book:
- [Lore](tome/terminology.markdown)
- [Terminology](tome/terminology.markdown)
- [Getting Started](tome/getting-started.markdown)
- [REST API Routes](tome/api.markdown)
- [Rust APIs](tome/rust-apis.markdown)
- [Contributing](tome/contributing.markdown)
## NOTE :scroll:
- *Kleah :swan: :black_heart:* by *Alyx Shang :black_heart:*.
- Licensed under the [FSL v1](https://github.com/alyxshang/fair-software-license).