1
- # ‼️ READ: THIS IS STILL IN DEVELOPMENT
2
-
3
- This is still in early development. Everything you see here may - and likely will - be tweaked or changed further before release.
4
-
5
1
# Revolt Frontend
6
2
7
- This repository contains the code for Revolt's new frontend, built with Solid.js.
3
+ This repository contains the code for Revolt's frontend, built with Solid.js.
8
4
9
5
You can find the code style guidelines [ here] ( ./GUIDELINES.md ) .
10
6
11
- ## Setup locally
7
+ ## Development Guide
8
+
9
+ Before getting started, you'll want to install:
10
+
11
+ - Git
12
+ - Node.js
13
+ - pnpm (run ` corepack enable ` )
14
+
15
+ Then proceed to setup:
12
16
13
17
``` bash
14
18
# clone the repository
@@ -33,17 +37,7 @@ pnpm dev
33
37
34
38
Finally, navigate to http://local.revolt.chat:5173 .
35
39
36
- ## Build client
37
-
38
- ``` bash
39
- # install packages
40
- pnpm i
41
-
42
- # build everything
43
- pnpm build:all
44
- ```
45
-
46
- ## Pulling in Revolt's assets
40
+ ### Pulling in Revolt's assets
47
41
48
42
If you want to pull in Revolt brand assets after pulling, run the following:
49
43
@@ -59,7 +53,7 @@ You can switch back to the fallback assets by running deinit and continuing as n
59
53
git submodule deinit packages/client/assets
60
54
```
61
55
62
- ## Faster iteration with Revolt.js
56
+ ### Faster iteration with Revolt.js
63
57
64
58
To make it easier to work with ` revolt.js ` , you may want to temporarily make this change:
65
59
@@ -71,21 +65,28 @@ To make it easier to work with `revolt.js`, you may want to temporarily make thi
71
65
72
66
Any edits to the revolt.js codebase will immediately be reflected while developing.
73
67
74
- ## Using ` pnpm `
68
+ ## Deployment Guide
75
69
76
- Add a new package to a workspace:
70
+ ### Build the app
77
71
78
72
``` bash
79
- pnpm add solid-hcaptcha --filter @revolt/auth
73
+ # install packages
74
+ pnpm i
75
+
76
+ # build everything
77
+ pnpm build:all
80
78
```
81
79
82
- # Deployment Information
80
+ ### Routing Information
83
81
84
82
The app currently needs the following routes:
85
83
86
84
- ` /server `
87
85
- ` /channel `
86
+ - ` /dev `
88
87
- ` /friends `
89
- - ` /admin `
90
88
- ` /app `
91
89
- ` /pwa `
90
+ - ` /settings `
91
+
92
+ This corresponds to [ Content.tsx#L33] ( packages/client/src/interface/Content.tsx ) .
0 commit comments