Docs: update docs sections from README

This commit is contained in:
Alex Gleason
2022-07-18 12:16:11 -05:00
parent 2f27d879cc
commit 1f62b53da2
3 changed files with 26 additions and 24 deletions

View File

@ -23,16 +23,22 @@ yarn dev
It will serve at `http://localhost:3036` by default.
It will proxy requests to the backend for you.
For Pleroma running on `localhost:4000` (the default) no other changes are required, just start a local Pleroma server and it should begin working.
You should see an input box - just enter the domain name of your instance to log in.
Tip: you can even enter a local instance like `http://localhost:3000`!
## Troubleshooting: `ERROR: NODE_ENV must be set`
Create a `.env` file if you haven't already.
```
```sh
cp .env.example .env
```
And ensure that it contains `NODE_ENV=development`.
Try again.
## Troubleshooting: it's not working!
Run `node -V` and compare your Node.js version with the version in [`.tool-versions`](https://gitlab.com/soapbox-pub/soapbox-fe/-/blob/develop/.tool-versions).
If they don't match, try installing [asdf](https://asdf-vm.com/).