Skip to content

Commit 915a1d6

Browse files
committed
docs: clean up README [skip ci]
1 parent ef349ab commit 915a1d6

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

GUIDELINES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Code Guidelines
22

3+
This repository uses prettier which does most of the heavy lifting for you, but there are some things below to keep in mind.
4+
35
Before reading additional recommendations below, I recommend checking out the [Airbnb JavaScript style guide](https://github.com/airbnb/javascript).
46

57
I am still working on putting stuff together, but here are some important things:

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
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-
51
# Revolt Frontend
62

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.
84

95
You can find the code style guidelines [here](./GUIDELINES.md).
106

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:
1216

1317
```bash
1418
# clone the repository
@@ -33,17 +37,7 @@ pnpm dev
3337

3438
Finally, navigate to http://local.revolt.chat:5173.
3539

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
4741

4842
If you want to pull in Revolt brand assets after pulling, run the following:
4943

@@ -59,7 +53,7 @@ You can switch back to the fallback assets by running deinit and continuing as n
5953
git submodule deinit packages/client/assets
6054
```
6155

62-
## Faster iteration with Revolt.js
56+
### Faster iteration with Revolt.js
6357

6458
To make it easier to work with `revolt.js`, you may want to temporarily make this change:
6559

@@ -71,21 +65,28 @@ To make it easier to work with `revolt.js`, you may want to temporarily make thi
7165

7266
Any edits to the revolt.js codebase will immediately be reflected while developing.
7367

74-
## Using `pnpm`
68+
## Deployment Guide
7569

76-
Add a new package to a workspace:
70+
### Build the app
7771

7872
```bash
79-
pnpm add solid-hcaptcha --filter @revolt/auth
73+
# install packages
74+
pnpm i
75+
76+
# build everything
77+
pnpm build:all
8078
```
8179

82-
# Deployment Information
80+
### Routing Information
8381

8482
The app currently needs the following routes:
8583

8684
- `/server`
8785
- `/channel`
86+
- `/dev`
8887
- `/friends`
89-
- `/admin`
9088
- `/app`
9189
- `/pwa`
90+
- `/settings`
91+
92+
This corresponds to [Content.tsx#L33](packages/client/src/interface/Content.tsx).

0 commit comments

Comments
 (0)