2011-03-10 03:41:05 +01:00
|
|
|
Budget-manager
|
|
|
|
|
##############
|
|
|
|
|
|
|
|
|
|
This is a really tiny app to ease the shared houses budget management. Keep
|
|
|
|
|
track of who bought what, when, and for who to then compute the balance of each
|
|
|
|
|
person.
|
2011-03-10 18:32:53 +01:00
|
|
|
|
2011-10-17 23:32:47 +02:00
|
|
|
The code is distributed under a BSD beerware derivative: if you meet the people
|
|
|
|
|
in person and you want to pay them a beer, you are encouraged to do so (see
|
|
|
|
|
LICENSE for more details).
|
|
|
|
|
|
2011-03-10 18:32:53 +01:00
|
|
|
Make it run!
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
To make it run, you just have to do something like::
|
|
|
|
|
|
|
|
|
|
$ virtualenv venv
|
2011-03-10 21:31:02 +01:00
|
|
|
$ source venv/bin/activate
|
2011-10-13 21:27:56 +02:00
|
|
|
$ pip install -r budget/requirements.txt
|
2011-03-10 18:32:53 +01:00
|
|
|
$ cd budget
|
2011-09-09 21:21:37 +02:00
|
|
|
$ python run.py
|
2011-03-10 18:32:53 +01:00
|
|
|
|
2011-10-13 21:27:56 +02:00
|
|
|
It is also better to actually turn the debugging mode on when you're
|
|
|
|
|
developing. You can create a `settings.py` file in the `budget` directory, with
|
|
|
|
|
the following content::
|
|
|
|
|
|
|
|
|
|
DEBUG = True
|
|
|
|
|
SQLACHEMY_ECHO = DEBUG
|
|
|
|
|
|
2011-03-10 18:32:53 +01:00
|
|
|
Deploy it
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
To deploy it, I'm using gunicorn and supervisord::
|
|
|
|
|
|
2011-03-10 18:51:16 +01:00
|
|
|
$ virtualenv venv
|
|
|
|
|
$ source venv/bin/activate
|
2011-07-30 15:40:48 +02:00
|
|
|
$ pip install -r requirements.txt
|
2011-03-10 18:51:16 +01:00
|
|
|
|
2011-03-10 18:32:53 +01:00
|
|
|
1. Add the lines in conf/supervisord.conf to your supervisord.conf file.
|
|
|
|
|
**adapt them to your paths!**
|
|
|
|
|
2. Copy and paste the content of conf/nginx.conf in your nginx conf file.
|
|
|
|
|
**adapt them to your paths!**
|
|
|
|
|
3. reload both nginx and supervisord. It should be working ;)
|
2011-03-10 18:51:16 +01:00
|
|
|
|
|
|
|
|
Don't forget to set the right permission for your files !
|
2011-09-09 21:32:52 +02:00
|
|
|
|
2011-10-13 21:27:56 +02:00
|
|
|
Also, create a `settings.py` file with the appropriate values if you need to
|
|
|
|
|
use a different database for instance.
|
|
|
|
|
|
2011-10-17 23:32:47 +02:00
|
|
|
How about the REST API?
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
Yep, you're right, there is a REST API with this. Head to the `api
|
|
|
|
|
documentation` to know more.
|
|
|
|
|
|
2011-09-09 21:32:52 +02:00
|
|
|
How to contribute
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
There are different ways to help us, regarding if you are a designer,
|
|
|
|
|
a developer or just an user.
|
|
|
|
|
|
|
|
|
|
As a developer
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
The best way to contribute code is to write it and to make a pull request on
|
|
|
|
|
github. Please, think about updating and running the tests before asking for
|
|
|
|
|
a pull request as it will help us to maintain the code clean and running.
|
|
|
|
|
|
2011-10-08 13:48:06 +02:00
|
|
|
To do so::
|
|
|
|
|
|
|
|
|
|
$ workon budget
|
|
|
|
|
(budget) $ python tests.py
|
|
|
|
|
|
|
|
|
|
before pushing anything to master :)
|
|
|
|
|
|
2011-09-09 21:32:52 +02:00
|
|
|
As a designer / Front-end developer
|
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
|
|
Feel free to provide us mockups or to involve yourself into the discussions
|
|
|
|
|
hapenning on the github issue tracker. All ideas are welcome. Of course, if you
|
|
|
|
|
know how to implement them, feel free to fork and make a pull request.
|
|
|
|
|
|
|
|
|
|
End-user
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
You just wanted to have a look at the application and found a bug? Please tell
|
|
|
|
|
us and go fill a new issue:
|
|
|
|
|
https://github.com/ametaireau/budget-manager/issues/new
|
