Mirrors
/
data-importer
mirror of https://github.com/firefly-iii/data-importer.git
3
0
Fork 0
Code Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
178 Commits
7 Branches
304 Tags
31 MiB
Tree: db9080f7bc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'db9080f7bc'
${ noResults }
data-importer/readme.md

123 lines
6.8 KiB
Raw Normal View History

Remove some CSV references
4 years ago
​
Update readme and references.
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Fix readme.
4 years ago
Add line to readme [skip ci]
4 years ago
Update readme and references.
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Fix readme.
4 years ago
Update readme and references.
4 years ago
​
​
​
​
​
​
Fix readme.
4 years ago
Update readme and references.
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. # Firefly III Data Importer
  3. [![Packagist][packagist-shield]][packagist-url]
  4. [![License][license-shield]][license-url]
  5. [![Stargazers][stars-shield]][stars-url]
  6. [![Donate][donate-shield]][donate-url]
  7. [![huntr][hack-shield]][hack-url]
  9. <!-- PROJECT LOGO -->
  10. <br />
  11. <p align="center">
  12. <a href="https://firefly-iii.org/">
  13. <img src="https://raw.githubusercontent.com/firefly-iii/firefly-iii/develop/.github/assets/img/logo-small.png" alt="Firefly III" width="120" height="178">
  14. </a>
  15. </p>
  16. <h1 align="center">Firefly III Data Importer</h1>
  18. <p align="center">
  19. Import your transactions into Firefly III
  20. <br />
  21. <a href="https://docs.firefly-iii.org/"><strong>Explore the documentation</strong></a>
  22. <br />
  23. <br />
  24. <a href="https://github.com/firefly-iii/firefly-iii/issues">Report a bug</a>
  25. ·
  26. <a href="https://github.com/firefly-iii/firefly-iii/issues">Request a feature</a>
  27. ·
  28. <a href="https://github.com/firefly-iii/firefly-iii/discussions">Ask questions</a>
  29. </p>
  32. ## About this data importer
  34. "Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. The **data importer** is built to help you import transactions into Firefly III. It is separated from Firefly III for security and maintenance reasons.
  36. The data importer does not connect to your bank directly. Instead, it uses [Nordigen](https://nordigen.com/en/coverage/) and [SaltEdge](https://www.saltedge.com/products/spectre/countries) to connect to over 6000 banks worldwide. These services are free for Firefly III users, but require registration.
  38. You can also import CSV files downloaded from your bank. Other import options are under construction.
  40. Eager to get started? Go to [the documentation](https://docs.firefly-iii.org/data-importer)!
  42. <!-- HELP TEXT -->
  43. ## Need help?
  45. If you need support using Firefly III or the associated tools, come find us!
  47. - [GitHub Discussions for questions and support](https://github.com/firefly-iii/firefly-iii/discussions/)
  48. - [Gitter.im for a good chat and a quick answer](https://gitter.im/firefly-iii/firefly-iii)
  49. - [GitHub Issues for bugs and issues](https://github.com/firefly-iii/firefly-iii/issues)
  50. - [Follow me around for news and updates on Twitter](https://twitter.com/Firefly_iii)
  52. <!-- END OF HELP TEXT -->
  54. ## Features
  56. * Import from over 6000 banks
  57. * Import over the command line for easy automation
  58. * Import over an API for easy automation
  59. * Use rules and data mapping for transaction clarity
  61. Many more features are listed in the [documentation](https://docs.firefly-iii.org/data-importer).
  63. ## Who's it for?
  65. This application is for people who want to track their finances, keep an eye on their money **without having to upload their financial records to the cloud**. You're a bit tech-savvy, you like open source software and you don't mind tinkering with (self-hosted) servers.
  67. ## Getting Started
  69. Many more features are listed in the [documentation](https://docs.firefly-iii.org/data-importer).
  71. ## Contributing
  73. You can contact me at [james@firefly-iii.org](mailto:james@firefly-iii.org), you may open an issue in the [main repository](https://github.com/firefly-iii/firefly-iii) or contact me through [gitter](https://gitter.im/firefly-iii/firefly-iii) and [Twitter](https://twitter.com/Firefly_III).
  75. Of course, there are some [contributing guidelines](https://github.com/firefly-iii/data-importer/blob/main/.github/contributing.md) and a [code of conduct](https://github.com/firefly-iii/data-importer/blob/main/.github/code_of_conduct.md), which I invite you to check out.
  77. I can always use your help [squashing bugs](https://docs.firefly-iii.org/support/contribute#bugs), thinking about [new features](https://docs.firefly-iii.org/support/contribute#feature-requests) or [translating Firefly III](https://docs.firefly-iii.org/support/contribute#translations) into other languages.
  79. [Sonarcloud][sc-project-url] scans the code of Firefly III. If you want to help improve Firefly III, check out the latest reports and take your pick!
  81. [![Quality Gate Status][sc-gate-shield]][sc-project-url] [![Bugs][sc-bugs-shield]][sc-project-url] [![Code Smells][sc-smells-shield]][sc-project-url] [![Vulnerabilities][sc-vuln-shield]][sc-project-url]
  83. There is also a [security policy](https://github.com/firefly-iii/data-importer/security/policy).
  85. ### Support the development of Firefly III
  87. If you like Firefly III and if it helps you save lots of money, why not send me a dime for every dollar saved! :tada:
  89. OK that was a joke. If you feel Firefly III made your life better, consider contributing as a sponsor. Please check out my [Patreon](https://www.patreon.com/jc5) and [GitHub Sponsors](https://github.com/sponsors/JC5) page for more information. Thank you for considering donating to Firefly III!
  91. ## License
  93. This work [is licensed](https://github.com/firefly-iii/data-importer/blob/main/LICENSE) under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.html).
  95. ## Contact
  97. You can contact me at [james@firefly-iii.org](mailto:james@firefly-iii.org), you may open an issue or contact me through the support channels:
  99. - [GitHub Discussions for questions and support](https://github.com/firefly-iii/firefly-iii/discussions/)
  100. - [Gitter.im for a good chat and a quick answer](https://gitter.im/firefly-iii/firefly-iii)
  101. - [GitHub Issues for bugs and issues](https://github.com/firefly-iii/firefly-iii/issues)
  102. - [Follow me around for news and updates on Twitter](https://twitter.com/Firefly_iii)
  104. ## Acknowledgements
  106. The Firefly III logo is made by the excellent Cherie Woo.
  108. [packagist-shield]: https://img.shields.io/packagist/v/firefly-iii/data-importer.svg?style=flat-square
  109. [packagist-url]: https://packagist.org/packages/firefly-iii/data-importer
  110. [license-shield]: https://img.shields.io/github/license/firefly-iii/data-importer.svg?style=flat-square
  111. [license-url]: https://www.gnu.org/licenses/agpl-3.0.html
  112. [stars-shield]: https://img.shields.io/github/stars/firefly-iii/data-importer.svg?style=flat-square
  113. [stars-url]: https://github.com/firefly-iii/data-importer/stargazers
  114. [donate-shield]: https://img.shields.io/badge/donate-%24%20%E2%82%AC-brightgreen?style=flat-square
  115. [donate-url]: #support-the-development-of-firefly-iii
  116. [hack-shield]: https://cdn.huntr.dev/huntr_security_badge_mono.svg
  117. [hack-url]: https://huntr.dev/bounties/disclose
  119. [sc-gate-shield]: https://sonarcloud.io/api/project_badges/measure?project=firefly-iii_data-importer&metric=alert_status
  120. [sc-bugs-shield]: https://sonarcloud.io/api/project_badges/measure?project=firefly-iii_data-importer&metric=bugs
  121. [sc-smells-shield]: https://sonarcloud.io/api/project_badges/measure?project=firefly-iii_data-importer&metric=code_smells
  122. [sc-vuln-shield]: https://sonarcloud.io/api/project_badges/measure?project=firefly-iii_data-importer&metric=vulnerabilities
  123. [sc-project-url]: https://sonarcloud.io/dashboard?id=firefly-iii_data-importer