chore: add readme and license
f6372e70
2 file(s) · +73 −0
| 1 | + | MIT License |
|
| 2 | + | ||
| 3 | + | Copyright (c) 2026 Steve Simkins |
|
| 4 | + | ||
| 5 | + | Permission is hereby granted, free of charge, to any person obtaining a copy |
|
| 6 | + | of this software and associated documentation files (the "Software"), to deal |
|
| 7 | + | in the Software without restriction, including without limitation the rights |
|
| 8 | + | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
| 9 | + | copies of the Software, and to permit persons to whom the Software is |
|
| 10 | + | furnished to do so, subject to the following conditions: |
|
| 11 | + | ||
| 12 | + | The above copyright notice and this permission notice shall be included in all |
|
| 13 | + | copies or substantial portions of the Software. |
|
| 14 | + | ||
| 15 | + | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
| 16 | + | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
| 17 | + | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
| 18 | + | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
| 19 | + | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
| 20 | + | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
| 21 | + | SOFTWARE. |
|
| 22 | + |
| 1 | + | # Andromeda |
|
| 2 | + | ||
| 3 | + |  |
|
| 4 | + | ||
| 5 | + | A Rust workspace of minimal, self-hosted web apps. Each app compiles to a single binary powered by Axum, SQLite, and Askama templates. |
|
| 6 | + | ||
| 7 | + | ## Apps |
|
| 8 | + | ||
| 9 | + | | App | Description | |
|
| 10 | + | |---|---| |
|
| 11 | + | | [**Sipp**](apps/sipp) | Minimal code sharing with web UI and TUI | |
|
| 12 | + | | [**Feeds**](apps/feeds) | Minimal RSS reader with FreshRSS and OPML support | |
|
| 13 | + | | [**Parcels**](apps/parcels) | Minimal package tracking (USPS) | |
|
| 14 | + | | [**Jotts**](apps/jotts) | Minimal markdown notes app | |
|
| 15 | + | | [**OG**](apps/og) | Open Graph tag inspector | |
|
| 16 | + | | [**Shrink**](apps/shrink) | Image compression and resizing | |
|
| 17 | + | ||
| 18 | + | ## Shared Crates |
|
| 19 | + | ||
| 20 | + | | Crate | Description | |
|
| 21 | + | |---|---| |
|
| 22 | + | | [`andromeda-auth`](crates/auth) | Session-based password authentication | |
|
| 23 | + | ||
| 24 | + | ## Stack |
|
| 25 | + | ||
| 26 | + | - **Axum** - web framework |
|
| 27 | + | - **SQLite** (rusqlite) - storage |
|
| 28 | + | - **Askama** - HTML templates |
|
| 29 | + | - **rust-embed** - embedded static assets |
|
| 30 | + | - **tokio** - async runtime |
|
| 31 | + | ||
| 32 | + | ## Getting Started |
|
| 33 | + | ||
| 34 | + | ```bash |
|
| 35 | + | # Build all apps |
|
| 36 | + | cargo build --release |
|
| 37 | + | ||
| 38 | + | # Run a specific app |
|
| 39 | + | cargo run -p sipp -- server --port 3000 |
|
| 40 | + | cargo run -p feeds |
|
| 41 | + | cargo run -p parcels |
|
| 42 | + | cargo run -p jotts |
|
| 43 | + | cargo run -p og |
|
| 44 | + | cargo run -p shrink |
|
| 45 | + | ``` |
|
| 46 | + | ||
| 47 | + | Each app has its own README with detailed setup, environment variables, and deployment instructions. |
|
| 48 | + | ||
| 49 | + | ## License |
|
| 50 | + | ||
| 51 | + | [MIT](LICENSE) |