summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno Wagner <bwgpro@gmail.com>2014-11-20 14:44:34 -0200
committerBruno Wagner <bwgpro@gmail.com>2014-11-20 14:46:09 -0200
commit2902b5acca9f8de1f8920a8f169abcff457d774c (patch)
tree6a901f82b920ebd407c7b181b476dd19d10d7374
parent907270df79d1d54ad8818ba2f21d214e57cf00bb (diff)
Updated readme and install-pixelated instructions
-rw-r--r--README.md70
-rwxr-xr-xinstall-pixelated.sh12
2 files changed, 35 insertions, 47 deletions
diff --git a/README.md b/README.md
index 6c2036c7..d888d2a0 100644
--- a/README.md
+++ b/README.md
@@ -6,74 +6,62 @@ This contains the Pixelated User Agent, which is composed of a web UI written as
>**The Pixelated User Agent is still in early development state!**
>Some things may not yet work the way you expect it to.
->Setting up the service (as opposed to the fake service or inbox-app) is still rather troublesome and so far it only serves limited functionality.
-
+>Setting up the service is still rather troublesome and so far it only serves limited functionality.
# Running it
-The User Agent is composed of 2 components:
-- The Web Ui, which is the the HTML, CSS and JS files served to the browser; and
-- The Service component, which is the web service that serves the Web Ui to the browser, provides the REST API which the the Web Ui uses, and integrates with the LEAP or Pixelated provider.
+The User Agent has 2 components:
+* The Web Ui, which is the the HTML, CSS and JS files served to the browser;
+* The Service component, which is the web service that serves the Web UI to the browser, provides the REST API which the the Web Ui uses, and integrates with the LEAP or Pixelated provider.
## Quickstart
Dependencies are: node, npm, ruby, bundle, virtualenv, git
-On Debian/Ubuntu systems you need:
+* To install the dependencies on debian/ubuntu you need to run `sudo apt-get install nodejs npm ruby bundler virtualenv git`
- sudo apt-get install nodejs npm ruby bundler virtualenv git
+* Next step is cloning the repository with `git clone https://github.com/pixelated-project/pixelated-user-agent.git`
-Once you have that, clone the repo and run inside:
+* Enter the folder `pixelated-user-agent`
-```
-/bin/bash install-pixelated.sh
-```
+* Run the setup `./install_pixelated.sh`
-_____________
+* After it finishes, you can activate the virtualenv with `source service/.virtualenv/bin/activate`
-## Web Ui
-The Web Ui needs to generate the templates and CSS to be served. For that, you need (from inside `./web-ui`) to run the command `./go build` at least once after downloading the code. From here on, you can run `./go watch` to auto-generate the resources as they are changed.
+* The user agent will be available with the command `pixelated-user-agent`, running it you will be prompted for the credentials and the user agent will be started at localhost:3333
+
+_____________
## Service
-## Fake Service
-This is a Fake Service used for testing the Web Ui. It works as the real service, but mocking the connection to the LEAP/Pixelated provider with a predefined dataset of emails.
+* Enter the `service` folder
+
+* Create the virtualenv with `virtualenv .virtualenv`
-To run the Fake Service, run the command `./go server:start` on the terminal. `./go server:restart` restarts the service.
+* Activate it with `source .virtualenv/bin/activate`
-# Setting things up
-Before being able to run the Service (the Fake or real), you must first set this components up by installing their dependencies.
+* Run the setup with `python setup.py develop --always-unzip`
+
+* Then, to run use `pixelated-user-agent` on the command line
+
+> You need an account in a Leap provider with support for email to test pixelated,
+> if you don't have one yet, you can register with the following command
+pixelated-user-agent --register your.provider.org desired_account
## Web Ui
-From inside `./web-ui`:
+
+* Enter the `web-ui` folder
+
+* Run:
```
$ bundle install
$ npm install
$ bower install
```
-If you don't have `bower` installed globaly, change the third line to `$ ./node_modules/bower/bin/bower install`
-
-## Service
-## Fake Service
-From inside `./fake-service`
-```
-$ virtualenv .virtualenv
-$ source .virtualenv/bin/activate
-$ pip install -r requirements.txt
-$ ./go
-```
+If you don't have `bower` installed globally, change the third line to `$ ./node_modules/bower/bin/bower install`
-If you want to see random emails on the fake service, run it like this
-```
-$ env AUTOLOAD=True ./go
-```
-
-If you want to control the emails you'll see on the fake service, edit the mailset.csv.example file
-and run the following command while the server is running
-```
-$ curl --data-binary @mailset.csv.example http://localhost:4567/control/mailset/csv/load
-```
+The Web Ui needs to generate the templates and CSS to be served. For that, you need (from inside `./web-ui`) to run the command `./go build` at least once after downloading the code. From here on, you can run `./go watch` to auto-generate the resources as they are changed.
And that's it.
diff --git a/install-pixelated.sh b/install-pixelated.sh
index 3ee52a84..0f618a16 100755
--- a/install-pixelated.sh
+++ b/install-pixelated.sh
@@ -48,14 +48,14 @@ cat <<EOF
###############
-## You will need an account in a LEAP provider. You may find some at http://bitmask.net/
+## You will need an account in a LEAP provider with mail support. You may find some at http://bitmask.net/
-## Once you have it, modify the service/pixelated.example file and move it to ~/.pixelated
-
-## You might also need to add your LEAP provider ssl certificate to the pixelated/certificates folder, named as your provider domain name (in case it uses TLS):
-## - example: your.leapprovider.org.crt
+## You might also need to add your LEAP provider ssl certificate to pixelated manually for now, with the following steps:
+## The easiest way to find this is accessing https://your.provider.org/ca.crt
+## Rename the certificate based on your provider domain name like this `your.leapprovider.org.crt`
+## Put it in services/pixelated/certificates/
## Once you are done, just run:
-## pixelated-user-agent
+## pixelated-user-agent
EOF