README.md: create

This commit is contained in:
Herb Caudill 2019-11-12 13:32:34 +01:00
parent 4b72546ddc
commit 60f08c61a5

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# Cevitxe Signal Server
See https://github.com/DevResults/cevitxe for information on what this is all about.
### Installing and running locally
```bash
yarn
yarn start
```
You should see confirmation on the command line that it's running.
```
🐟 Listening at http://localhost:8080
```
You can visit that address with a web browser to confirm that it's active. If it is, you'll see this:
![image](https://user-images.githubusercontent.com/2136620/68671483-b37b9f00-054f-11ea-8043-c5f028e38ef2.png)
### Deploying with Heroku
```bash
heroku create
git push heroku master
```