mirror of
https://codeberg.org/likwid/likwid.git
synced 2026-02-09 13:03:10 +00:00
docs: refresh README
This commit is contained in:
parent
a78d974ad4
commit
9327268478
1 changed files with 157 additions and 148 deletions
31
README.md
31
README.md
|
|
@ -21,13 +21,15 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
## Features
|
||||
|
||||
### Deliberative Democracy
|
||||
|
||||
- **Inform → Discuss → Decide** workflow for proposals
|
||||
- Resource libraries for informed participation
|
||||
- Small group discussions with facilitators
|
||||
- Optional facilitator role on proposals
|
||||
- "Read before discuss" requirements
|
||||
- Constructive comment visibility scoring
|
||||
- Comment reactions for quality signals (agree/disagree/insightful/constructive/off-topic)
|
||||
|
||||
### Advanced Voting Methods
|
||||
|
||||
- **Approval Voting** — vote for multiple options
|
||||
- **Ranked Choice** — order preferences
|
||||
- **Schulze Method** — Condorcet-consistent pairwise comparison
|
||||
|
|
@ -35,6 +37,7 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
- **Quadratic Voting** — express intensity of preference
|
||||
|
||||
### Liquid Delegation
|
||||
|
||||
- Delegate your vote globally or within a community
|
||||
- Real-time transparency: see how delegates vote
|
||||
- Revoke delegation instantly
|
||||
|
|
@ -42,6 +45,7 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
- Delegation analytics and trust networks
|
||||
|
||||
### Modular Plugin System
|
||||
|
||||
- WASM-based sandboxed plugins
|
||||
- Per-community plugin configuration
|
||||
- Hook-based architecture (actions/filters)
|
||||
|
|
@ -49,16 +53,16 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
- Admin policy for signed/unsigned plugins
|
||||
|
||||
### Governance Infrastructure
|
||||
|
||||
- Multi-community platform support
|
||||
- Granular admin controls (platform mode, registration, moderation)
|
||||
- Public moderation ledger (immutable)
|
||||
- Tamper-evident public moderation ledger
|
||||
- Role-based access (admin, moderator, facilitator, member)
|
||||
- Anonymous voting with identity separation
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
|-------|------------|
|
||||
| --- | --- |
|
||||
| **Backend** | Rust (Axum 0.8, Tokio, SQLx) |
|
||||
| **Frontend** | Astro + TypeScript |
|
||||
| **Database** | PostgreSQL 16 |
|
||||
|
|
@ -70,12 +74,14 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
### Prerequisites
|
||||
|
||||
**Windows:**
|
||||
|
||||
- Windows 10/11 with WSL2
|
||||
- Podman Desktop (WSL2 backend)
|
||||
- Rust (rustup, MSVC toolchain)
|
||||
- Node.js LTS
|
||||
|
||||
**Linux:**
|
||||
|
||||
- Podman + podman-compose
|
||||
- Rust (rustup)
|
||||
- Node.js LTS
|
||||
|
|
@ -84,9 +90,9 @@ Likwid implements a set of principles for **modular governance infrastructure**:
|
|||
|
||||
```powershell
|
||||
# 1. Clone and configure
|
||||
git clone https://invent.kde.org/marcoa/likwid.git
|
||||
git clone https://codeberg.org/likwid/likwid.git
|
||||
cd likwid
|
||||
cp backend/.env.example backend/.env
|
||||
$env:JWT_SECRET="dev_secret_change_me"
|
||||
|
||||
# 2. Start everything (database + backend + frontend)
|
||||
.\scripts\dev-start.ps1
|
||||
|
|
@ -96,9 +102,10 @@ cp backend/.env.example backend/.env
|
|||
```
|
||||
|
||||
The platform will be available at:
|
||||
- **Frontend**: http://localhost:4321
|
||||
- **Backend API**: http://localhost:3000
|
||||
- **Setup Wizard**: http://localhost:4321/setup (first run)
|
||||
|
||||
- **Frontend**: <http://localhost:4321>
|
||||
- **Backend API**: <http://localhost:3000>
|
||||
- **Setup Wizard**: <http://localhost:4321/setup> (first run)
|
||||
|
||||
### First Run
|
||||
|
||||
|
|
@ -109,7 +116,7 @@ The platform will be available at:
|
|||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
```text
|
||||
likwid/
|
||||
├── backend/ # Rust backend
|
||||
│ ├── src/
|
||||
|
|
@ -139,9 +146,11 @@ likwid/
|
|||
## License
|
||||
|
||||
EUPL-1.2
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Inspired by:
|
||||
|
||||
- [Pol.is](https://pol.is/) — Opinion mapping
|
||||
- [Decidim](https://decidim.org/) — Participatory democracy
|
||||
- [LiquidFeedback](https://liquidfeedback.org/) — Liquid democracy
|
||||
|
|
|
|||
Loading…
Reference in a new issue