LearnFi

A web-based learning platform that helps beginners learn the basics of investing.
Learn how to build a portfolio, analyse assets and more.
Explore the docs »

View App · Report Bug · Request Feature

Table of Contents

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

About The Project

🤔 When I began my investing journey in 2019, I found that most online tools and resources to learn investing were not friendly to beginners. They often assumed prior financial knowledge and used fancy letters and words (sometimes even in Greek!) without explanation.

💡 I wanted to help democratise financial literacy, and I thought that there is no better way of doing that than building my own project to share my own learning with the online community. And so my idea was born! Now I just had to build it...

🧑‍🎓 This web app uses a "learn-by-doing" approach to teach you:

• What are the different asset classes (stocks, bonds, real estate, commodities, etc.)
• How to build a portfolio
• How to analyse a portfolio (risk, returns etc.)

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/syedtaqi95/learnfi.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

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

(back to top)

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

(back to top)

License

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

(back to top)

Contact

Your Name - syed.taqi95@gmail.com

Project Link: https://github.com/syedtaqi95/learnfi

(back to top)