Skip to content

GoPlan-Finance/utils

Repository files navigation

Markdownify
GoPlan Finance Utils

An intuitive utility library for Parse-Server and Parse-SDK!

Discord

⭐ Star us on GitHub — it helps!

RoadmapHow To UseNotes & disclamersLicense

screenshot

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

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