Flesh out README

This commit is contained in:
Drew DeVault 2017-12-29 14:15:10 -05:00
parent f27caad7b8
commit 62f474ef95

View File

@ -1,20 +1,43 @@
# receptor # 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) [![](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 A hosted instance is available at https://web.synapse-bt.org.
bug reports from right now and they know who they are.
## Usage ## Installation
Run synapse on localhost with the default RPC port.
```shell ```shell
$ git submodule update --init --recursive git submodule update --init --recursive
$ npm install npm install
$ npm start 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;
}
}
```