natty
/
magnetar
1
0
Fork 0
Code Issues 4 Pull Requests 1 Packages Projects Releases Wiki Activity

Added Nova :3
ci/woodpecker/push/ociImagePush Pipeline was successful Details

This commit is contained in:
Natty 2024-12-03 02:42:11 +01:00
parent 5363a0c137
commit 207da854a9
Signed by: natty
GPG Key ID: BF6CB659ADEE60EC
1 changed files with 38 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,9 +1,9 @@
# magnetar
![Magnetar logo, an 8-pointed star with two symmetrical cones](./fe_calckey/frontend/assets/favicon.png)
A social networking server anyone can self-host
![Nova, the foxgirl mascot of Magnetar, themed purple, orange, and blue](/doc/nova.webp)
**This project is in early development.**
## Quick start
@ -24,6 +24,7 @@ Read further for additional information.
## What's inside
Magnetar builds to two primary binaries:
- magnetar -- The backend
- magnetar_calckey_fe -- A web server hosting a self-contained frontend
@ -43,9 +44,11 @@ Magnetar can be built both as standalone binaries or OCI containers (Podman, Doc
### Native
Building the Magnetar backend requires:
- latest stable Rust toolchain
Building the included Magnetar/Calckey frontend requires:
- latest stable Rust toolchain
- Node.js and npm