summaryrefslogtreecommitdiff
authorGiulio Cesare Solaroli <giulio.cesare@clipperz.com>2013-05-03 12:35:05 (UTC)
committer Giulio Cesare Solaroli <giulio.cesare@clipperz.com>2013-05-03 12:35:05 (UTC)
commit77c90371a3055d0ad61d48f22207585948c591bf (patch) (side-by-side diff)
treefd26098d4c6ad0aedb167f45d7c371a21b599447
parented2375435d8a2bb5ae6185761619b49ea7f98778 (diff)
downloadclipperz-77c90371a3055d0ad61d48f22207585948c591bf.zip
clipperz-77c90371a3055d0ad61d48f22207585948c591bf.tar.gz
clipperz-77c90371a3055d0ad61d48f22207585948c591bf.tar.bz2
Fixed the markup of the README.md file.
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index b15887d..e44df48 100644
--- a/README.md
+++ b/README.md
@@ -76,35 +76,36 @@ This script, located in `scripts/dev-proxy`, is invoked without any parameters (
The aim of this proxy is to mask the actual location of frontend JS files from the actual backend handling requests.
When executed, this script will start listening on localhost:8888.
All 'backend' requests (whose path starts with either `/json` or `/dump`) will be forwarded to the actual backend, that is configured as a `ReverseProxyResource` (in the current code: `proxy.ReverseProxyResource('localhost', 8084, '/java-backend')`).
All other requests (html files, Javascript code, CSS stylesheets and other resources) will be handled by reading the resource from the filesystem; the proxy is aware of the layout of the project, so it will be able to locate the right resource in the right place.
The only file that needs to be `build`, and not read directly from the file system, is the `index.html` file.
In order to build this file, the following command should be executed:
./scripts/build --frontends beta gamma gamma.mobile --backends dev
Once the index.html files have been built (one for each frontend) and a backend is running and has been correctly configured in the proxy script, it is possible to access the different versions of the application at the following URLs:
- - `http://localhost:8888/beta/index.html`
- - `http://localhost:8888/gamma/index.html`
- - `http://localhost:8888/gamma/index.mobile.html`
+
+- `http://localhost:8888/beta/index.html`
+- `http://localhost:8888/gamma/index.html`
+- `http://localhost:8888/gamma/index.mobile.html`
## Installing
### PHP + MySQL backend
* **PHP**
Once the project has been successfully build, the application needs to be moved in a location where the web server can run it. Everything that is needed is located into `target/php`.
* **MySQL**
The application needs a simple MySQL database; to configure all the credentials to access the previously allocated DB, edit the file found in `php/configuration.php`. You need to edit the file actually used by the web server; this will usually be the one moved into the right place in the previous step.
Once the application is in place, and the DB credentials have been configured, you should initialize the DB itself; in order to do so, just point your browser at the following url: `http://<host>/<path>/php/setup/index.php`.
Here you will find the standard [POG][pog] setup page: it should be enough to click the "POG me up!" button at the bottom of the page, and then the "Process" button on the next page.
The POG interface will allow also a very basic access to the DB data that may be useful to check that the application is actually writing something on the DB (even if you will not be able to make much sense out of the data you will see, as they are all encrypted!)
More information about building the PHP backend may be found in the `doc/install.php.txt` file.