aboutsummaryrefslogtreecommitdiff
path: root/javascript/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'javascript/README.md')
-rw-r--r--javascript/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/javascript/README.md b/javascript/README.md
new file mode 100644
index 0000000..d73ef9e
--- /dev/null
+++ b/javascript/README.md
@@ -0,0 +1,26 @@
+# haskell-code-explorer
+
+## Prerequisites
+* [Node.js](https://nodejs.org/) (with NPM)
+* [Ember CLI](https://ember-cli.com/)
+* [bower](https://bower.io/)
+
+## Installation
+* `cd haskell-code-explorer/javascript`
+* `npm install`
+* `bower install`
+
+## Running / Development
+* Start haskell-code-server on port 8080
+* `ember server --port=4200 --proxy=http://localhost:8080`
+* Visit your app at [http://localhost:4200](http://localhost:4200).
+
+To test the app with real-world data :
+* ember server --proxy=https://haskell-code-explorer.mfix.io/
+
+## Running Tests
+* `ember server --port=4200`
+* Open [http://localhost:4200/tests](http://localhost:4200/tests) in a browser
+
+## Building
+* `ember build --environment production`