docs: 📝 Make README prettier, add LICENSE

This commit is contained in:
Jesse Wierzbinski 2024-06-09 17:53:51 -10:00
parent ef9a6f1da4
commit 192c7f83c3
No known key found for this signature in database
2 changed files with 709 additions and 7 deletions

View file

@ -2,7 +2,7 @@
<a href="https://lysand.org"><img src="https://cdn.lysand.org/logo-long-dark.webp" alt="Lysand Logo" height="110"></a>
</p>
# Lysand-FE
<center><h1><code>lysand-fe</code></h1></center>
**Lysand-FE** is a beautiful, fast and responsive front-end for the Lysand project.
@ -13,17 +13,43 @@
- [x] Notifications
- [x] Replies
- [x] Quotes
- [x] Markdown posts
- [x] Markdown posts (quasi-unrestricted)
- [x] Dark mode
- [x] Following
- [x] Multiple accounts
- [x] Custom Emojis
- [x] Lysand Permissions support
- [x] Note editing
- [x] Alt text support everywhere
- [x] Media uploads
- [ ] Settings
- [ ] Profile editing
## Tech Stack
### Browser Support
- [**Nuxt**](https://nuxt.com) - The Intuitive Vue Framework
- [**TailwindCSS**](https://tailwindcss.com) - A utility-first CSS framework
- [**TypeScript**](https://typescriptlang.org) - A typed superset of JavaScript
The following browsers are **supported** (issues will be prioritized):
- **Chromium**: `110+`
- **Firefox**: `110+`
- **Safari**: `16+`
- **IE**: None.
The following browsers will very likely work, but are not officially supported:
- **Chromium**: `80+`
- **Firefox**: `80+`
- **Safari**: `12+`
- **IE**: None.
Other browsers may work, but are not guaranteed to.
## Performance
### JavaScript Bloat
The **total** JavaScript bundle size is less than `900 kB`, but this is made even smaller by the fact that the bundle is split into multiple files, and only the necessary files are loaded on each page.
### Benchmarks
Benchmarks are due to be conducted soon™.
## Installation
@ -49,4 +75,19 @@ services:
NUXT_PUBLIC_API_HOST: https://yourserver.com
```
Then, the frontend will be available at `http://localhost:3000` inside the container. To link it to a Lysand Server, set the `NUXT_PUBLIC_API_HOST` environment variable to the server's URL.
Then, the frontend will be available at `http://localhost:3000` inside the container. To link it to a Lysand Server, set the `NUXT_PUBLIC_API_HOST` environment variable to the server's URL.
## License
This project is licensed under the AGPL 3.0 - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
### Projects
- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.
- [**Nuxt**](https://nuxt.com): Thanks to the Nuxt team for creating an amazing Vue framework.
### People
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Lysand Server ActivityPub bridge.