From 9840548ffc68e68ec1bd3d91e2cdfcbe92a492f4 Mon Sep 17 00:00:00 2001 From: Bruno Wagner Date: Mon, 9 Feb 2015 13:39:24 -0200 Subject: Rephrased some things on the README and removed the provision README as its contents are already on the main README now --- README.md | 13 +++++-------- provisioning/README.md | 23 ----------------------- 2 files changed, 5 insertions(+), 31 deletions(-) delete mode 100644 provisioning/README.md diff --git a/README.md b/README.md index a383eb27..9f295cd2 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This contains the Pixelated User Agent, which is composed of a web UI written as # Running it 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. +* The Service component, which is the web service that serves the Web UI to the browser, provides the REST API which the Web Ui uses, and integrates with the LEAP or Pixelated provider. ## Quickstart @@ -25,10 +25,10 @@ Clone the repository: git clone https://github.com/pixelated-project/pixelated-user-agent.git -From the root folder, set up the vagrant machine: +From the root folder, set up the vagrant machine: vagrant up source - + You can log into the machine using: vagrant ssh @@ -73,11 +73,11 @@ node, npm, compass (ruby), virtualenv, git * Enter the `service` folder -* Create the virtualenv with `virtualenv .virtualenv` +* Create the virtualenv with `virtualenv .virtualenv` * Activate it with `source .virtualenv/bin/activate` -* Install the test dependencies with `pip install -r test_requirements.txt` +* Install the test dependencies with `pip install -r test_requirements.txt` * Run the setup with `python setup.py develop` @@ -122,6 +122,3 @@ apt-get update apt-get install pixelated-user-agent ``` - -**Warning:** Currently there are some challenges with the dependencies. To make the user agent work see instructions used to build the docker image: [Dockerfile](provisioning/Dockerfile). - diff --git a/provisioning/README.md b/provisioning/README.md deleted file mode 100644 index ee6c14ee..00000000 --- a/provisioning/README.md +++ /dev/null @@ -1,23 +0,0 @@ - Setup for developers -===================== -The following instructions describe how to setup a Vagrant box for development. You need to have Vagrant installed on your system (tested using Vagrant 1.7.1). - -# Vagrant setup - -Create and provision Vagrant box (from inside the user-agent repository) -```sh -$ vagrant up -``` - -# Running the server -Enter the vagrant box, activate virtualenv and run Pixelated server: -```sh -$ vagrant ssh -$ cd /vagrant/service -$ source .virtualenv/bin/activate -$ pixelated-user-agent --host 0.0.0.0 -``` - -After this you will be asked to setup a LEAP provider. Once entering valid LEAP credentials, you should have the server running. - -You should now be able to access the web app by accessing http://localhost:3333 in your favourite browser on your host machine. -- cgit v1.2.3