Commit ca6179bc authored by Nelso Jost's avatar Nelso Jost

FIX: improved README.md instructions

parent c081873d
......@@ -21,6 +21,7 @@ $ make setup # creates a virtualenv (for local requirements) and initiate
* OBS: Debian packages to be installed with `make install` via `apt-get`:
* **nginx**: reverse proxy web server (for serving static files);
* **supervisor**: allows easy monitoring and restarting of the gunicorn process;
* **python3**: interpreter wich will be runing the app;
* **python3-pip**: Python's own package manager;
* **virtualenv** (installed via pip): allows the creation of a local, custom, Python installation, which contains all required Python libraries for the project (see the file `requirements.pip`);
......@@ -29,7 +30,7 @@ $ make setup # creates a virtualenv (for local requirements) and initiate
* **Development**:
```
$ make run # launch the Flask werkzeug development server (DEBUG=True)
$ make run # launch Flask's werkzeug development server (DEBUG=True)
```
Check under http://localhost:5000. By default runs with `DEBUG=True`, which means that the server will reload automatically on source code changes.
Hit CTRL + C to cancel the execution.
......@@ -38,16 +39,20 @@ Hit CTRL + C to cancel the execution.
```
$ make deploy # register site on nginx and launch a gunicorn process via supervisor
```
Check under http://localhost or the registered domain.
Undo the deployment and quit related processeses with:
Check under http://localhost or the registered domain. Default port: 8000.
* Alternativaly, you can specify another port with:
```
$ make deploy PORT=9090
```
* Undo the production deployment and quit related processeses with:
```
$ make undeploy
```
### 3. Additional commands
Explore the database (see [SQLAlchemy](http://www.sqlalchemy.org/)) with:
* Explore the database (see [SQLAlchemy](http://www.sqlalchemy.org/)) with:
```
$ make shell
venv/bin/ipython manage.py shell
......@@ -111,10 +116,11 @@ Check under http://localhost:5000. By default runs with `DEBUG=True`.
(venv) $ python production/nginx-gunicorn/deploy.py
```
Check under http://localhost or the registered domain.
Undo the deployment and quit related processeses with:
```
(venv) $ python production/nginx-gunicorn/undeploy.py
```
* Undo the deployment and quit related processeses with:
```
(venv) $ python production/nginx-gunicorn/undeploy.py
```
### 3. Additional commands
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment