Skip to content

Latest commit

 

History

History
 
 

frontend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
codemirror-beancount
codemirror-beancount
 
 
third_party/fava
third_party/fava
 
 
README.md
README.md
 
 
account_input.tsx
account_input.tsx
 
 
app.tsx
app.tsx
 
 
candidate.tsx
candidate.tsx
 
 
candidates.tsx
candidates.tsx
 
 
editor.tsx
editor.tsx
 
 
invalid_references.tsx
invalid_references.tsx
 
 
journal_errors.tsx
journal_errors.tsx
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
pending.tsx
pending.tsx
 
 
server_connection.ts
server_connection.ts
 
 
server_virtual_list.tsx
server_virtual_list.tsx
 
 
source_data.tsx
source_data.tsx
 
 
transaction_line_editor.tsx
transaction_line_editor.tsx
 
 
tsconfig.json
tsconfig.json
 
 
uncleared.tsx
uncleared.tsx
 
 
used_transactions.tsx
used_transactions.tsx
 
 
virtual_list.tsx
virtual_list.tsx
 
 
webpack.config.js
webpack.config.js
 
 

README.md

This directory contains the source code for the Beancount-import web frontend.

The web frontend communicates with a Python server (typically running on the same machine) over a websocket. The Python server also serves a copy of the frontend code.

Development

In order to use the modified version after making changes, you must run the build command, which requires some additional setup:

  1. A recent version of Node.js is required to build the frontend. The recommended way to obtain Node.js is by installing NVM (node version manager) by following the instructions here:

    https://github.com/creationix/nvm

  2. Install a recent version of Node.js by running:

    nvm install stable

    You can also specify a version manually.

  3. From within this directory, install the dependencies required by this project:

    npm install

  4. To build a development version of the frontend, run:

    npm run builddev

    Alternatively, you can run:

    npm run builddev:watch

    This watches the source tree and incrementally rebuilds as changes are made. This is the recommended command to use during development.

  5. The build output is written to the (beancount_import/frontend_dist/)[../beancount_import/frontend_dist/] directory. When using the builddev or builddev:watch commands, the frontend is built in development mode and the output is written to the dev subdirectory. When using the build command, the frontend is built in production mode and the output is written to the prod sub-directory. Note that only the index.html file contained in the dev or prod directory is actually used. The main.bundle.js file is just an intermediate output.

  6. By default, the Python server serves the index.html file in the prod directory. As the builddev and builddev:watch commands update the dev directory only, you must specify the --dev command-line option when running Beancount-import in order to use the dev version.