hackerESQ
2.9 KiB
About Investbrain
Investbrain helps you manage and track the performance of your investments.
Installation
For ease of installation, we highly recommend installing Investbrain in a Docker container using the provided Docker Compose option, which downloads all the necessary dependencies and builds everything you need to get started quickly!
To get started, you can clone this repository:
git clone https://github.com/investbrainapp/investbrain.git .
Once the repository is cloned, enter the directory:
cd investbrain
And bring up the container (this will take a few minutes):
docker composer up
If everything worked as expected, you should now be able to access Investbrain in the browser at:
http://localhost:8000/register
Congrats! You've just installed Investbrain!
Updating
To update Investbrain using the recommended Docker installation method, you just need to stop the running containers:
docker compose stop
Then pull the latest updates from this repository using git:
git pull
Then bring the containers back up!
docker compose up
Easy as that!
Under the hood
Investbrain is a Laravel PHP web application that leverages the Livewire and Mary UI frameworks for its frontend. As far as persistent data storage, any relational database should work (but we generally recommend SQLite or MySQL). There are out of the box market data providers for Yahoo Finance, Alpha Vantage, and an extensible market data provider interface. We also have robust i18n, a11y, and dark mode support.
Contributing
We appreciate any contributions to Investbrain! Please open a pull request on our Github repository. Here are some ideas for first time contributors:
- Improve our documentation
- Create new market data providers
- Enhance the user interface
- Additional translations
- Fix bugs
When you submit a contribution, don't forget to include passing tests with your PR!
Code of Conduct
We ask that you be kind and polite when interacting with the Investbrain community.
Security Vulnerabilities
If you discover a security vulnerability within Investbrain, please create an issue in the Github repository. All security vulnerabilities will be promptly addressed.
License
Investbrain is open-sourced software licensed under the CC-BY-NC 4.0.