mirror of
https://github.com/versia-pub/frontend.git
synced 2025-12-06 08:28:20 +01:00
docs: 📝 Refactor README to improve appearance
This commit is contained in:
parent
70c83daea8
commit
c5387dbaaa
75
README.md
75
README.md
|
|
@ -1,12 +1,42 @@
|
||||||
<p align="center">
|
<center>
|
||||||
<a href="https://versia.pub"><img src="https://cdn.versia.pub/branding/logo-dark.svg" alt="Versia Logo" height="110"></a>
|
<a href="https://versia.pub">
|
||||||
</p>
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://cdn.versia.pub/branding/logo-dark.svg">
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://cdn.versia.pub/branding/logo-light.svg">
|
||||||
|
<img src="https://cdn.versia.pub/branding/logo-dark.svg" alt="Versia Logo" height="110" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
|
</center>
|
||||||
|
|
||||||
<center><h1><code>versia-fe</code></h1></center>
|
|
||||||
|
|
||||||
**Versia-FE** is a beautiful, fast and responsive front-end for the Versia Server project.
|
<h2 align="center">
|
||||||
|
<strong><code>Versia Frontend</code></strong>
|
||||||
|
</h2>
|
||||||
|
|
||||||
## Features
|
<div align="center">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/typescript/typescript-original.svg" height="42" width="52" alt="TypeScript logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/vuejs/vuejs-original.svg" height="42" width="52" alt="Vue logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nuxtjs/nuxtjs-original.svg" height="42" width="52" alt="Nuxt logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/docker/docker-original.svg" height="42" width="52" alt="Docker logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/bun/bun-original.svg" height="42" width="52" alt="Bun logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/css3/css3-original.svg" height="42" width="52" alt="CSS3 logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/html5/html5-original.svg" height="42" width="52" alt="HTML5 logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/linux/linux-original.svg" height="42" width="52" alt="Linux logo">
|
||||||
|
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/tailwindcss/tailwindcss-original.svg" height="42" width="52" alt="TailwindCSS logo">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
<center>
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="assets/ipad-dark.webp">
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="assets/ipad-light.webp">
|
||||||
|
<img alt="Versia-FE screenshot on an iPad Pro" src="assets/ipad-dark.webp" height="400" />
|
||||||
|
</picture>
|
||||||
|
</center>
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
- [x] Timelines: public, home, local
|
- [x] Timelines: public, home, local
|
||||||
- [x] Login
|
- [x] Login
|
||||||
|
|
@ -22,12 +52,11 @@
|
||||||
- [x] Note editing
|
- [x] Note editing
|
||||||
- [x] Alt text support everywhere
|
- [x] Alt text support everywhere
|
||||||
- [x] Media uploads
|
- [x] Media uploads
|
||||||
- [x] WCAG 2.2 AAA compliance
|
- [x] WCAG 2.2 AAA testing
|
||||||
- Testing is automated and will not catch all issues, please report any accessibility issues you find.
|
|
||||||
- [x] Settings
|
- [x] Settings
|
||||||
- [x] Profile editing
|
- [x] Profile editing
|
||||||
|
|
||||||
### Browser Support
|
## Browser Support
|
||||||
|
|
||||||
The following browsers are **supported** (issues will be prioritized):
|
The following browsers are **supported** (issues will be prioritized):
|
||||||
- **Chromium**: `110+`
|
- **Chromium**: `110+`
|
||||||
|
|
@ -43,27 +72,27 @@ The following browsers will very likely work, but are not officially supported:
|
||||||
|
|
||||||
Other browsers may work, but are not guaranteed to.
|
Other browsers may work, but are not guaranteed to.
|
||||||
|
|
||||||
## Performance
|
# Performance
|
||||||
|
|
||||||
### JavaScript
|
## JavaScript
|
||||||
|
|
||||||
The **total** JavaScript bundle size is less than `1000 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.
|
The **total** JavaScript bundle size is less than `1000 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
|
||||||
|
|
||||||
Soon™.
|
Soon™.
|
||||||
|
|
||||||
## Installation
|
# Installation
|
||||||
|
|
||||||
Versia-FE is included in the provided `docker-compose` file during [Versia Server installation](https://github.com/versia-pub/server/blob/main/docs/installation.md).
|
Versia-FE is included in the provided `docker-compose` file during [Versia Server installation](https://github.com/versia-pub/server/blob/main/docs/installation.md).
|
||||||
|
|
||||||
To have Versia-FE and Versia Server running on the same domain, edit the Versia Server configuration to point to the Versia-FE container's address (`frontend` category inside config).
|
To have Versia-FE and Versia Server running on the same domain, edit the Versia Server configuration to point to the Versia-FE container's address (`frontend` category inside config).
|
||||||
|
|
||||||
### Manual Installation
|
## Manual Installation
|
||||||
|
|
||||||
Here are the steps to install Versia-FE manually:
|
Here are the steps to install Versia-FE manually:
|
||||||
|
|
||||||
#### Docker/Podman
|
### Docker/Podman
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
services:
|
services:
|
||||||
|
|
@ -83,7 +112,7 @@ Then, the frontend will be available at `http://localhost:3000` inside the conta
|
||||||
>
|
>
|
||||||
> You can set the `NUXT_PUBLIC_API_HOST` environment variable to point to a different Versia Server instance.
|
> You can set the `NUXT_PUBLIC_API_HOST` environment variable to point to a different Versia Server instance.
|
||||||
|
|
||||||
#### Manual
|
### Manual
|
||||||
|
|
||||||
1. Clone the repository.
|
1. Clone the repository.
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -99,26 +128,26 @@ bun run build
|
||||||
```
|
```
|
||||||
4. Serve the static files in the `.output/public` directory.
|
4. Serve the static files in the `.output/public` directory.
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
>
|
>
|
||||||
> `.output/public/200.html` should be configured as a fallback for all 404 errors.
|
> `.output/public/200.html` should be configured as a fallback for all 404 errors.
|
||||||
|
|
||||||
## Development
|
# Development
|
||||||
|
|
||||||
Run `bun run emojis:generate` to generate the emoji list before building or running the project.
|
Run `bun run emojis:generate` to generate the emoji list before building or running the project.
|
||||||
|
|
||||||
## License
|
# License
|
||||||
|
|
||||||
This project is licensed under the AGPL 3.0 - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the AGPL 3.0 - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
All Versia assets (icon, logo, banners, etc) are licensed under [CC-BY-NC-SA-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0).
|
All Versia assets (icon, logo, banners, etc) are licensed under [CC-BY-NC-SA-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0).
|
||||||
|
|
||||||
## Acknowledgments
|
# Acknowledgments
|
||||||
|
|
||||||
### Projects
|
## Projects
|
||||||
|
|
||||||
- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.
|
- [**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.
|
- [**Nuxt**](https://nuxt.com): Thanks to the Nuxt team for creating an amazing Vue framework.
|
||||||
|
|
||||||
### People
|
## People
|
||||||
|
|
||||||
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.
|
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.
|
||||||
|
|
|
||||||
BIN
assets/ipad-dark.webp
Normal file
BIN
assets/ipad-dark.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
BIN
assets/ipad-light.webp
Normal file
BIN
assets/ipad-light.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Loading…
Reference in a new issue