Investment Dashboard
View Demo · Report Bug · Support

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Links

About The Project

Investapp is a client-side web application that allows users simulate trading stocks with a starting balance.

Built With

• React for UI building.
• Plotly.js for data visualization.
• Chackra UI for UI styling.
• JavaScript, HTML, CSS as a general stack to build web applications.

Getting Started

To get and run a local copy of this project follow the instructions below.

Installation

1. Clone the repo

   git clone https://github.com/oscargonzalezdev/investment-dashboard-client.git

2. Install NPM packages

   npm install

3. Run the project locally

   npm start

Roadmap

• Layout component.
• Welcomme component to set name and initial deposit.
• Stock section to show trending stocks
• Investments section to diplay a list of transactions.
• Wallet section to manage deposits and transfers.
• News section to display top and breaking news.
• Overview section containing a selection of components.
• Search functionality for stocks.
• Watchlist component.
• Component to show investment performance.

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Author

www.oscargonzalez.dev | LinkedIn | Twitter

Links

• GitHub repository: https://github.com/oscargonzalezdev/investment-dashboard-client
• Demo: https://investapp.oscargonzalez.dev

(back to top)