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

43
README.md
View File

@ -1,31 +1,32 @@
# 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
1. Create a Postgres database
2. Create a Redis instance
3. Configure the required options in `config/default.toml`
4. Build Magnetar: `cargo build --release --workspace --bins`
5. Build the Magnetar Calckey frontend: `cd fe_calckey/frontend && pnpm install && pnpm run build`
6. Run Magnetar: `./target/release/magnetar`
7. Build and run [a modified version of Calckey](https://git.astolfo.cool/natty/calckey),
1. Create a Postgres database
2. Create a Redis instance
3. Configure the required options in `config/default.toml`
4. Build Magnetar: `cargo build --release --workspace --bins`
5. Build the Magnetar Calckey frontend: `cd fe_calckey/frontend && pnpm install && pnpm run build`
6. Run Magnetar: `./target/release/magnetar`
7. Build and run [a modified version of Calckey](https://git.astolfo.cool/natty/calckey),
pointed to the same database and Redis
8. Start up the Magnetar frontend: `./target/release/magnetar_calckey_fe`
9. Set up a reverse proxy based on `.dev/Caddyfile`
8. Start up the Magnetar frontend: `./target/release/magnetar_calckey_fe`
9. Set up a reverse proxy based on `.dev/Caddyfile`
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
- magnetar -- The backend
- magnetar_calckey_fe -- A web server hosting a self-contained frontend
The `fe_calckey/frontend` directory contains the
[Calckey](https://codeberg.org/firefish/firefish)-based web frontend.
@ -43,27 +44,29 @@ Magnetar can be built both as standalone binaries or OCI containers (Podman, Doc
### Native
Building the Magnetar backend requires:
- latest stable Rust toolchain
- latest stable Rust toolchain
Building the included Magnetar/Calckey frontend requires:
- latest stable Rust toolchain
- Node.js and npm
- latest stable Rust toolchain
- Node.js and npm
#### Steps
1. Build both the frontend and the backend binaries:
1. Build both the frontend and the backend binaries:
```shell
cargo build --release --workspace --bins
```
2. Switch to the frontend directory:
2. Switch to the frontend directory:
```shell
cd fe_calckey/frontend
```
3. Install the frontend dependencies:
3. Install the frontend dependencies:
```shell
pnpm install
```
4. Build the frontend
4. Build the frontend
```shell
pnpm run build
```