1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
Development
===========
Setting up a development environment
------------------------------------
If you want to hack on Fava or run the latest development version, make sure
you have recent enough versions of the following installed (ideally with your
system package manager):
- `Python 3`_ - with `pip` (at least v21.3), to install the Fava Python package,
- `Node.js`_ - with `npm`, to install the Javascript dependencies,
- `tox`_ - to run the Python tests,
- `pre-commit`_ - to lint changes with a git pre-commit hook.
.. _Python 3: https://www.python.org/
.. _Node.js: https://nodejs.org/
.. _tox: https://tox.wiki/en/latest/
.. _pre-commit: https://pre-commit.com/
Then this will get you up and running:
.. code:: bash
git clone https://github.com/beancount/fava.git
cd fava
# setup a virtual environment (at .venv) and install Fava into it
# alternatively, run `make dev` to do these next two steps with `uv` instead
python -m venv .venv
pip install --editable .
# add a git pre-commit hook to run linters
pre-commit install
You can start Fava in the virtual environment as usual by running ``fava``.
Running in debug mode with ``fava --debug`` is useful for development.
You can run the tests with ``make test`` and the linters by running ``make
lint``. There are further make targets defined, see the `Makefile` for details.
After any changes to the Javascript code, you will need to re-build the
frontend, which you can do by running ``make``. If you are working on the
frontend code, running ``npm run dev`` in the ``frontend`` folder will watch
for file changes and rebuild the Javascript bundle continuously.
If you need a newer version of Beancount than the latest released one, you can
install from source like so (more details `here
<http://furius.ca/beancount/doc/install>`_):
.. code:: bash
pip install git+https://github.com/beancount/beancount@v2
Contributions are very welcome, just open a PR on `GitHub`_.
Fava is released under the `MIT License`_.
.. _GitHub: https://github.com/beancount/fava/pulls
.. _MIT License: https://github.com/beancount/fava/blob/main/LICENSE
|
