aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.rst
diff options
context:
space:
mode:
authorJocelynDelalande <JocelynDelalande@users.noreply.github.com>2017-08-20 12:25:57 +0200
committerAlexis Metaireau <alexis@notmyidea.org>2017-08-20 12:25:57 +0200
commit68e411473540c136dfdb269af888ceddbd0d403b (patch)
tree6752263a0ca9018733c4b998cd673406a5638331 /docs/contributing.rst
parenta0d4917ac413cff938b7607bf8e36a64622257ef (diff)
downloadihatemoney-mirror-68e411473540c136dfdb269af888ceddbd0d403b.zip
ihatemoney-mirror-68e411473540c136dfdb269af888ceddbd0d403b.tar.gz
ihatemoney-mirror-68e411473540c136dfdb269af888ceddbd0d403b.tar.bz2
Streamline installation doc, now using pip (#252)
* Fix conf files to reflect module renaming Python module was renamed budget → ihatemoney (see #243 and 6923367). Now, "budget" relates to nothing. * Harmonize `APPLICATION_ROOT` doc with other settings * Fix link markup * Switch documentation to recomend pip over git - Update installation instruction - Clearly separate dev setup from installation - Some rewordings/section-ization by the way * Add a hint on how to find the static path This is a downside on the pip choice over git for installation. We will have to ease that a bit. By doc or by code, before next release. * Make the nginx deployment doc more accurate * Add a big fat warning about SECRET_KEY in doc
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r--docs/contributing.rst48
1 files changed, 47 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index b0a829f..d2bdbcc 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -4,6 +4,52 @@ Contributing
Setup a dev environment
=======================
+You must develop on top of the git master branch::
+
+ git clone https://github.com/spiral-project/ihatemoney.git
+
+Then you need to build your dev environments. Choose your way…
+
+The quick way
+-------------
+
+If System :ref:`installation-requirements` are fulfilled, you can just issue::
+
+ make serve
+
+It will setup a `virtualenv <https://pypi.python.org/pypi/virtualenv>`_,
+install dependencies, and run the test server.
+
+The hard way
+------------
+
+Alternatively, you can also use the `requirements.txt` file to install the
+dependencies yourself. That would be::
+
+ pip install -r requirements.txt
+
+And then run the application::
+
+ cd ihatemoney
+ python run.py
+
+Accessing dev server
+--------------------
+
+In any case, you can point your browser at `http://localhost:5000 <http://localhost:5000>`_.
+It's as simple as that!
+
+
+Updating
+--------
+
+In case you want to update to newer versions (from git), you can just run the "update" command::
+
+ make update
+
+Useful settings
+----------------
+
It is better to actually turn the debugging mode on when you're developing.
You can create a ``settings.cfg`` file, with the following content::
@@ -47,7 +93,7 @@ End-user
--------
You are using the application and found a bug? You have some ideas about how to
-improve the project? Please tell us [by filling a new issue](https://github.com/spiral-project/ihatemoney/issues).
+improve the project? Please tell us `by filling a new issue <https://github.com/spiral-project/ihatemoney/issues>`_.
Or, if you prefer, you can send me an email to `alexis@notmyidea.org` and I will
update the issue tracker with your feedback.