mirror of
https://github.com/jcreek/BankStatementAnalyser.git
synced 2026-07-12 18:43:49 +00:00
Josh Creek
31 lines
1.7 KiB
Markdown
31 lines
1.7 KiB
Markdown
# BankStatementAnalyser
|
|
|
|
A tiny web app to display graphs and stats from a bank statement/csv/google sheet.
|
|
|
|
## Developing locally
|
|
|
|
My recommendation is to use [vscode](https://code.visualstudio.com/), install [Docker](https://www.docker.com/products/docker-desktop/), and install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension. This will allow you to open the project in a Docker container, with no need to install anything else on your machine. No dependencies, nothing. Everything you need to run the project is commited to the repo and will be installed automatically into the Docker container.
|
|
|
|
To run the project locally with hot reload, use the command `npm run dev`.
|
|
|
|
All linting errors can be automatically fixed (usually) by running `npm run lint -- --fix` before you commit your changes.
|
|
|
|
This project uses symantic versioning. `Major.Minor.Patch` e.g. 1.1.2
|
|
|
|
When you create your Pull Request, ensure you add the relevant git tag using something like `git tag -a 1.1.0 -m "Add PWA support"` or `git tag -a 1.1.1 -m "Fix input duplication"`, then `git push origin --tags` to push the tag to the repository.
|
|
|
|
## Development notes
|
|
|
|
You can access a list of all the assets when debugging by visiting `http://localhost:3000/webpack-dev-server`
|
|
|
|
## Credits
|
|
|
|
### Favicon
|
|
|
|
This favicon was [generated](https://favicon.io/favicon-generator/) using the following font:
|
|
|
|
- Font Title: Cormorant Garamond
|
|
- Font Author: Copyright 2015 The Cormorant Project Authors (github.com/CatharsisFonts/Cormorant)
|
|
- Font Source: http://fonts.gstatic.com/s/cormorantgaramond/v16/co3YmX5slCNuHLi8bLeY9MK7whWMhyjQEl5vuQWJ5heb_w.ttf
|
|
- Font License: SIL Open Font License, 1.1 (http://scripts.sil.org/OFL))
|