You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<img alt="Versia-FE screenshot on an iPad Pro" src="assets/ipad-dark.webp" height="400" />
36
+
</picture>
37
+
</center>
38
+
39
+
# Features
10
40
11
41
-[x] Timelines: public, home, local
12
42
-[x] Login
@@ -22,12 +52,11 @@
22
52
-[x] Note editing
23
53
-[x] Alt text support everywhere
24
54
-[x] Media uploads
25
-
-[x] WCAG 2.2 AAA compliance
26
-
- Testing is automated and will not catch all issues, please report any accessibility issues you find.
55
+
-[x] WCAG 2.2 AAA testing
27
56
-[x] Settings
28
57
-[x] Profile editing
29
58
30
-
###Browser Support
59
+
## Browser Support
31
60
32
61
The following browsers are **supported** (issues will be prioritized):
33
62
-**Chromium**: `110+`
@@ -43,27 +72,27 @@ The following browsers will very likely work, but are not officially supported:
43
72
44
73
Other browsers may work, but are not guaranteed to.
45
74
46
-
##Performance
75
+
# Performance
47
76
48
-
###JavaScript
77
+
## JavaScript
49
78
50
79
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.
51
80
52
-
###Benchmarks
81
+
## Benchmarks
53
82
54
83
Soon™.
55
84
56
-
##Installation
85
+
# Installation
57
86
58
87
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).
59
88
60
89
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).
61
90
62
-
###Manual Installation
91
+
## Manual Installation
63
92
64
93
Here are the steps to install Versia-FE manually:
65
94
66
-
####Docker/Podman
95
+
### Docker/Podman
67
96
68
97
```yaml
69
98
services:
@@ -83,7 +112,7 @@ Then, the frontend will be available at `http://localhost:3000` inside the conta
83
112
>
84
113
> You can set the `NUXT_PUBLIC_API_HOST` environment variable to point to a different Versia Server instance.
85
114
86
-
#### Manual
115
+
### Manual
87
116
88
117
1. Clone the repository.
89
118
```bash
@@ -99,26 +128,26 @@ bun run build
99
128
```
100
129
4. Serve the static files in the `.output/public` directory.
101
130
> [!WARNING]
102
-
>
131
+
>
103
132
> `.output/public/200.html` should be configured as a fallback for all 404 errors.
104
133
105
-
## Development
134
+
# Development
106
135
107
136
Run `bun run emojis:generate` to generate the emoji list before building or running the project.
108
137
109
-
## License
138
+
# License
110
139
111
140
This project is licensed under the AGPL 3.0 - see the [LICENSE](LICENSE) file for details.
112
141
113
142
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).
114
143
115
-
## Acknowledgments
144
+
# Acknowledgments
116
145
117
-
### Projects
146
+
## Projects
118
147
119
148
- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.
120
149
- [**Nuxt**](https://nuxt.com): Thanks to the Nuxt team for creating an amazing Vue framework.
121
150
122
-
### People
151
+
## People
123
152
124
-
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.
153
+
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.
0 commit comments