| author | Giulio 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) |
| commit | 77c90371a3055d0ad61d48f22207585948c591bf (patch) (unidiff) | |
| tree | fd26098d4c6ad0aedb167f45d7c371a21b599447 | |
| parent | ed2375435d8a2bb5ae6185761619b49ea7f98778 (diff) | |
| download | clipperz-77c90371a3055d0ad61d48f22207585948c591bf.zip clipperz-77c90371a3055d0ad61d48f22207585948c591bf.tar.gz clipperz-77c90371a3055d0ad61d48f22207585948c591bf.tar.bz2 | |
Fixed the markup of the README.md file.
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
| @@ -80,27 +80,28 @@ When executed, this script will start listening on localhost:8888. | |||
| 80 | 80 | ||
| 81 | 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')`). | 81 | 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')`). |
| 82 | 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. | 82 | 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. |
| 83 | 83 | ||
| 84 | The only file that needs to be `build`, and not read directly from the file system, is the `index.html` file. | 84 | The only file that needs to be `build`, and not read directly from the file system, is the `index.html` file. |
| 85 | 85 | ||
| 86 | In order to build this file, the following command should be executed: | 86 | In order to build this file, the following command should be executed: |
| 87 | 87 | ||
| 88 | ./scripts/build --frontends beta gamma gamma.mobile --backends dev | 88 | ./scripts/build --frontends beta gamma gamma.mobile --backends dev |
| 89 | 89 | ||
| 90 | 90 | ||
| 91 | 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: | 91 | 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: |
| 92 | - `http://localhost:8888/beta/index.html` | 92 | |
| 93 | - `http://localhost:8888/gamma/index.html` | 93 | - `http://localhost:8888/beta/index.html` |
| 94 | - `http://localhost:8888/gamma/index.mobile.html` | 94 | - `http://localhost:8888/gamma/index.html` |
| 95 | - `http://localhost:8888/gamma/index.mobile.html` | ||
| 95 | 96 | ||
| 96 | 97 | ||
| 97 | ## Installing | 98 | ## Installing |
| 98 | 99 | ||
| 99 | ### PHP + MySQL backend | 100 | ### PHP + MySQL backend |
| 100 | 101 | ||
| 101 | * **PHP** | 102 | * **PHP** |
| 102 | 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`. | 103 | 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`. |
| 103 | 104 | ||
| 104 | * **MySQL** | 105 | * **MySQL** |
| 105 | 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. | 106 | 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. |
| 106 | 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`. | 107 | 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`. |