Flesh out README
This commit is contained in:
parent
f27caad7b8
commit
62f474ef95
43
README.md
43
README.md
|
@ -1,20 +1,43 @@
|
|||
# receptor
|
||||
|
||||
WIP web frontend for [synapse](https://github.com/Luminarys/synapse).
|
||||
Web frontend for [synapse](https://github.com/Luminarys/synapse).
|
||||
|
||||
[![](https://sr.ht/PQfE.png)](https://sr.ht/PQfE.png)
|
||||
|
||||
I really mean it when I say "WIP" here. There's only a few people that I want
|
||||
bug reports from right now and they know who they are.
|
||||
A hosted instance is available at https://web.synapse-bt.org.
|
||||
|
||||
## Usage
|
||||
|
||||
Run synapse on localhost with the default RPC port.
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
$ git submodule update --init --recursive
|
||||
$ npm install
|
||||
$ npm start
|
||||
git submodule update --init --recursive
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
Go to http://localhost:3000
|
||||
At this point you can navigate to http://localhost:3000 to make sure everything
|
||||
worked. At this point your configuration should be suitable for local
|
||||
development. For a production installation, press Ctrl-C and continue:
|
||||
|
||||
```shell
|
||||
npm run build:production
|
||||
```
|
||||
|
||||
Serve `index.html` and the `dist/` directory as static content on your web
|
||||
server. You'll need to serve index.html for any route that would otherwise 404.
|
||||
Here's an example nginx configuration:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
server_name web.synapse-bt.org;
|
||||
listen 80;
|
||||
|
||||
location / {
|
||||
root /var/www/path/to/site;
|
||||
try_files $uri /index.html;
|
||||
}
|
||||
|
||||
location /dist {
|
||||
root /var/www/path/to/site/dist;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue
Block a user