summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2017-10-21 21:56:01 +0300
committerYuval Adam <_@yuv.al>2017-10-21 21:56:01 +0300
commit4a7c8a531e4745c0c8a2966bd5de46e521445713 (patch)
treeb93b7297a248e39d80f2a9acb60769c52ed8ca31
parentac2686c129fec5b36830af832b94460b848c9690 (diff)
Update README
-rw-r--r--README.md27
1 files changed, 10 insertions, 17 deletions
diff --git a/README.md b/README.md
index 871ec13..83a1c3e 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,28 @@
# Geshem
-A rain radar clone running on Mapbox GL, see it live at: [http://geshem.space](http://geshem.space)
+An interactive rain radar clone running on Mapbox GL, see it live at: [https://geshem.space](https://geshem.space)
## Dev
- - Python 3.5
+ - Node + Yarn
- Redis (optional, recommended)
-Setup a virtualenv:
-
+Install dependencies:
```bash
-$ mkvirtualenv -p `which python3` geshem
-$ pip install -r requirements.txt
+$ yarn install
```
-Then just run:
-
+Run a local cache:
```bash
-$ python geshem.py
+$ redis-server
```
-For doing JS/SCSS work you'll need to init the JS stack:
-
+Run a webpack watch process:
```bash
-$ yarn install
+$ webpack --watch
```
-and pack all the assets before testing and/or deploying:
-
+Run the server:
```bash
-$ NODE_ENV=production webpack
+$ node server.js
```
-
-Make sure you have a stupid `redis-server` running on localhost to enjoy some sane caching.