Skip to content
Snippets Groups Projects
Commit 28e2f471 authored by Matthieu Simon's avatar Matthieu Simon
Browse files

update readme

parent f6ca7a01
No related branches found
No related tags found
No related merge requests found
......@@ -36,6 +36,10 @@ Now you can just enter the following command to get Flask activated in your virt
## Core dependencies
The project has been developped for `python2.7`.
On Unix systems, to install python dependencies, you may need to install `python-dev` package.
On OSX, in order to prevent some warnings, you should first run:
```
......@@ -48,6 +52,8 @@ Then we just install all the packages required (run this on all systems)
$ pip install -r requirements.txt
```
Databases are managed by `SQLite3`.
Psutil is needed for gathering system usage/performance stats on the worker. Ideally psutil is needed only on the workers.
Congratulations, brender and its dependencies should be correctly installed and ready to run. As a final step we should add a couple of hostnames into the `/etc/hosts` file:
......@@ -68,17 +74,17 @@ $ cd manager; ./manage.py db upgrade
```
## Running brender
It's pretty simple. Move into the brender folder and run - in four different terminals:
It's pretty simple. Move into each node folder and run - in four different terminals:
```
$ ./brender.py dashboard # will start the dashboard
$ cd server; ./manage.py runserver # will start the server
$ cd manager; ./manage.py runserver # will start the manager
$ ./brender.py worker # will start the worker
$ ./manage.py runserver # will start the node (dashoard, server, manager or worker according to the current folder)
```
If you now visit `http://brender-dashboard:8888` with your web browser you should see the dashboard!
It is also possible to configure the different applications. You may find a `config.py.example`, so you can rename
it to `config.py` and edit it before run the application.
## Architecture
At the moment the content of the `brender` folder is quite messy due to refactoring. The important subfolders are:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment