moth11.net
frontend for xcvr appview
update readme, add todo
+20
-33
README.md
+20
-33
README.md
···
1
-
# sv
1
+
hi! welcome to xcvr-frontend!
2
2
3
-
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
3
+
evidently this is a frontend for the xcvr appview, built with sveltekit. the
4
+
backend is xcvr-backend, also known as rvcx.
4
5
5
-
## Creating a project
6
+
to run this, i believe you do npm install and npm run dev. i think you need to
7
+
create a file titled `.env` in this top level directory with text
8
+
`VITE_API_URL=http://localhost:8080` in development, or
9
+
`VITE_API_URL=https://YOUR.DOMAIN` in production, i believe
6
10
7
-
If you're seeing this, you've probably already done this step. Congrats!
11
+
in production, i use the b script (with sudo) to build and serve, this will
12
+
probably change bc it takes way too long and i don't wanna sit around doing
13
+
nothing for 15 seconds but if you're using the nginx config provided in rvcx,
14
+
that will deploy the built server to the appropriate place more or less.
8
15
9
-
```bash
10
-
# create a new project in the current directory
11
-
npx sv create
16
+
if you'd like to contribute, i'd appreciate any help with respect to anything,
17
+
but maybe let me know in advance, both cause i probably am leaving out 99999%
18
+
of the information about how these programs actually work, and because as you
19
+
can see my commit history is not the cleanest. git is a bit mysterious to me
20
+
and i mostly have been testing in production since i didn't think learning how
21
+
to set up local oauth testing was worth it a few months ago, but i can be much
22
+
cleaner if others are interested in contributing.
12
23
13
-
# create a new project in my-app
14
-
npx sv create my-app
15
-
```
16
-
17
-
## Developing
18
-
19
-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
20
-
21
-
```bash
22
-
npm run dev
23
-
24
-
# or start the server and open the app in a new browser tab
25
-
npm run dev -- --open
26
-
```
27
-
28
-
## Building
29
-
30
-
To create a production version of your app:
31
-
32
-
```bash
33
-
npm run build
34
-
```
35
-
36
-
You can preview the production build with `npm run preview`.
37
-
38
-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
24
+
as for licenses, i think this is probably under mit, but i don't know all too
25
+
much about that crap.
+4
src/routes/+page.svelte
+4
src/routes/+page.svelte
···
151
151
<span class="mobile">(press aaaaa)</span> and start chatting, make your own,
152
152
or login with atproto if you'd like (it's optional, but recommended)
153
153
</p>
154
+
<p>
155
+
at this point in history (saturday july 26) probably most things work like
156
+
70% but expect it to be a bit unpredictable!
157
+
</p>
154
158
<p style="border-bottom: .25rem solid var(--fg)">
155
159
don't be weird, don't be mean, you're on our computer screens<span
156
160
class="footnote">5</span
+21
src/routes/todo/+page.svelte
+21
src/routes/todo/+page.svelte
···
1
+
<main>
2
+
<h2>known bugs</h2>
3
+
<p>
4
+
<b> undo/redo in chat </b> is currently disabled because i believe the events
5
+
which fire on these actions don't provide me with enough information to properly
6
+
broadcast which text was deleted and which text was appended, so i believe i
7
+
need to find a diff library that won't force me to delete the whole message and
8
+
rebroadcast it every history event
9
+
</p>
10
+
<p>
11
+
<b> inability to validate messages </b> occurs at some points in time, possibly
12
+
after the backend restarts, but i'm not totally sure how or why, oauth is a bit
13
+
mysterious to me still and it's likely a silly error somewhere but if you suddenly
14
+
are unable to make any records while logged in, then you should log out and log
15
+
back in
16
+
</p>
17
+
<h2>upcoming features</h2>
18
+
<p>
19
+
<b> whitelist / blacklist </b> is something that i'll probably add soon
20
+
</p>
21
+
</main>