From 349cfd8a5d57959e8baceeadb51db3cdb7837eba 2016-11-25 13:04:04
From: Marcin Lulek <info@webreactor.eu>
Date: 2016-11-25 13:04:04
Subject: [PATCH] readme: updated readme

---

diff --git a/readme.rst b/README.md
similarity index 51%
rename from readme.rst
rename to README.md
index 80fc50e..7f3dc7f 100644
--- a/readme.rst
+++ b/README.md
@@ -10,56 +10,88 @@ You can also use `packer` files in `/automation/packer` to create whole VM's for
 Manual Installation
 ===================
 
+To run the app you need to have meet prerequsites:
+
+- python 3.5+
+- running elasticsearch (2.3+ tested)
+- running postgresql (9.5+ required)
+- running redis
+
 Install the app by performing
 
     pip install -r requirements.txt
     
     python setup.py develop
 
-To run the app and configure datastore you need to run:
-
-* python 3.5+
-* elasticsearch (2.2+ tested)
-* postgresql 9.5+
-* redis 2.8+
+Install the appenlight uptime plugin (`ae_uptime_ce` package).
 
-after installing the application you need to:
+After installing the application you need to perform following steps:
 
 1. (optional) generate production.ini (or use a copy of development.ini)
 
+
     appenlight-make-config production.ini
 
-2. setup database structure:
+2. Setup database structure:
+
 
     appenlight-migrate-db -c FILENAME.ini
 
-3. to configure elasticsearch:
+3. To configure elasticsearch:
 
-    appenlight-reindex-elasticsearch -c FILENAME.ini
 
-4. create base database objects
+    appenlight-reindex-elasticsearch -t all -c FILENAME.ini
+
+4. Create base database objects
+
 
     appenlight-initializedb -c FILENAME.ini
 
-5. generate static assets
+5. Generate static assets
+
 
     appenlight-static -c FILENAME.ini
 
 Running application
 ===================
 
-to run the main app:
+To run the main app:
 
     pserve development.ini
 
-to run celery workers:
+To run celery workers:
 
     celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
 
-to run celery beat:
+To run celery beat:
 
     celery beat -A appenlight.celery --ini FILENAME.ini
 
-to run appenlight's uptime plugin:
+To run appenlight's uptime plugin:
 
     appenlight-uptime-monitor -c FILENAME.ini
+
+Real-time Notifications
+=======================
+
+You should also run the `channelstream websocket server for real-time notifications
+
+    channelstream -i filename.ini
+    
+Testing
+=======
+
+To run test suite:
+
+    py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
+
+
+Development
+===========
+
+To develop appenlight frontend:
+
+    cd frontend
+    npm install
+    bower install
+    grunt watch
diff --git a/backend/README.md b/backend/README.md
deleted file mode 100644
index 84d2f9a..0000000
--- a/backend/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# appenlight README
-
-
-To run the app you need to have meet prerequsites:
-
-- python 3.5+
-- running elasticsearch (2.3+ tested)
-- running postgresql (9.5+ required)
-- running redis
-
-# Setup basics
-
-Set up the basic application database schema:
-
-    appenlight_initialize_db config.ini
-
-Set up basic elasticsearch schema:
-
-    appenlight-reindex-elasticsearch -c config.ini -t all
-
-Installed the appenlight uptime plugin
-
-# Running
-
-To run the application itself:
-
-    pserve --reload development.ini
-
-To run celery queue processing:
-
-    celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini=development.ini
-
-To run celery beats scheduling:
-
-    celery beat -A appenlight.celery --ini=development.ini
-
-You should also run the `channelstream websocket server for real-time notifications
-
-    channelstream -i filename.ini
-
-# Testing
-
-To run test suite:
-
-    py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
-
-WARNING!!!
-Some tests will insert data into elasticsearch or redis based on testing.ini
diff --git a/backend/setup.py b/backend/setup.py
index df8d242..abbefad 100644
--- a/backend/setup.py
+++ b/backend/setup.py
@@ -5,7 +5,7 @@ import re
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.md')).read()
+README = open(os.path.join(here, '..', 'README.md')).read()
 CHANGES = open(os.path.join(here, 'CHANGELOG.rst')).read()
 
 REQUIREMENTS = open(os.path.join(here, 'requirements.txt')).readlines()