@goplan-finance/utils
v1.1.3
Published
<h1 align="center"> <a href="http://goplan.finance/"><img src="https://github.com/GoPlan-Finance/GoPlan-app/raw/master/frontend/public/images/logos/logo-full.png" alt="Markdownify" width="400"></a> <br> GoPlan Finance Utils <br> </h1>
Downloads
302
Readme
Roadmap
We seek to create a financial planning platform for the general public. Allocation dashboards, investment management tools, portfolio allocation, optimization, risk assessment, simulation, and forecasting. The tools of quantitative analysts and financial planners in hands of the regular investor and general public.
Feel free to submit a PR if you want to add items to the Roadmap!
How To Use
npm i GoPlan-Finance/utils
// or
yarn add GoPlan-Finance/utils
// or
git clone https://github.com/GoPlan-Finance/utils
npm run build
npm run test
Testing and debugging
This is fairly straitforwoard:
npm i
# This will rebuild the code, when you make change in the code
npm run watch
If you find anoying watch
recompile typescript on every changes. You can do this
Open a separate terminal and run (and leave runnning) :
npm run watch
When you are ready to test your changes:
npm run test
How to contribute
- You have an idea ? Submit it in Discussions
- You found a bug ? Submit it in Issues
- You found a security issue ? Contact a moderator in private
- You want to chat ? Say Hi! On discord
Notes
A note on Warranty and Limitation of Liability.
We are not in any way professional traders, financials experts or financial advisors. This is an open source project created by passionate developers for free.
Considering that this application is related to the financial sector and stock market, there is a special attention that was drawn toward ensuring accuracy of the information displayed and how the handling of confidential information is made.
That said, the good faith and commitment of the team in this project shall not be in any case confused for a warranty of any sort.
Please refer to section 16
and 17
of the LICENSE for any details
A note on cryptography and data protection
This project has not been, for now, reviewed by an independent security firm. We are open to a partnership.
License
GPL v3