It's pretty simple. Move into each folder (dashboard, server, manager or worker) and run:
It's pretty simple. Move into each folder (dashboard, server, manager or worker)
and run:
```
$ ./manage.py runserver # will start the different components
```
When running this command for the Manager for the first time, you will be prompted for some configuration parameters.
When running this command for the Manager for the first time, you will be
prompted for some configuration parameters.
If you now visit `http://localhost:8888` with your web browser you should see the dashboard!
...
...
@@ -77,8 +113,11 @@ The important subfolders are:
*`manager` containing the manager files (manage clusters)
*`dashboard` containing the dashboard (web interface to talk to the server)
This structure explains also the naming conventions adopted to distinguish the different parts of Flamenco.
Each folder contains an individual Flask application (except for the worker). Server, Manager and Worker exchange JSON formatted messages between each other via a REST API.
This structure explains also the naming conventions adopted to distinguish the
different parts of Flamenco.
Each folder contains an individual Flask application (except for the worker).
Server, Manager and Worker exchange JSON formatted messages between each other
via a REST API.
Dashboard connects to the Server only and accepts connections from clients (Browsers).
...
...
@@ -91,8 +130,10 @@ Frameworks and tools used by the interface are:
### User and Developer documentation
The documentation is built with Sphinx and uses the readthedocs.org theme, so make sure you have it installed. Instructions are available here:
The documentation is built with Sphinx and uses the readthedocs.org theme, so
make sure you have it installed. Instructions are available here:
`https://github.com/snide/sphinx_rtd_theme`
The `_build` contains the locally compiled documentation, which does not need to be committed to the branch.
The `_build` contains the locally compiled documentation, which does not need