receptor/README.md

44 lines
990 B
Markdown
Raw Normal View History

2017-08-25 05:10:37 +02:00
# receptor
2017-12-29 20:15:10 +01:00
Web frontend for [synapse](https://github.com/Luminarys/synapse).
2017-08-25 05:10:37 +02:00
2017-12-29 20:04:30 +01:00
[![](https://sr.ht/PQfE.png)](https://sr.ht/PQfE.png)
2017-08-25 05:10:37 +02:00
2017-12-29 20:15:10 +01:00
A hosted instance is available at https://web.synapse-bt.org.
2017-08-25 05:10:37 +02:00
2017-12-29 20:15:10 +01:00
## Installation
2017-08-25 05:10:37 +02:00
2017-12-29 20:15:10 +01:00
```shell
git submodule update --init --recursive
npm install
npm start
```
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:
2017-08-25 05:10:37 +02:00
```shell
2017-12-29 20:15:10 +01:00
npm run build:production
2017-08-25 05:10:37 +02:00
```
2017-12-29 20:15:10 +01:00
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;
}
}
```