StockMatch

StockMatch is an app that offers tailored stock recommendations based on user preferences, simplifying the search for ideal investment opportunities.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Demo Video
   • Demo Images
   • Built With
2. Getting Started
   • Prerequisites
   • Installations and Setups
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contacts

About The Project

StockMatch is a project aimed at investors who prefer a straightforward and interactive approach to stock management and discovery. It's built to streamline the process of creating a personalized watchlist with an easy-to-use interface that responds to the user's investment preferences.

Utilizing real-time financial data from Finnhub and yFinance, StockMatch keeps users informed with the latest stock updates. The robust backend, built on Java Spring and supported by a Postgres database, ensures efficient data management.

The React-based frontend provides a clean and intuitive user experience, while Python and Go microservices fetch financial data, aiding users in their stock selection journey.

StockMatch is a tool for anyone interested in a hands-on approach to learning and enhancing their investment knowledge.

Key Features:

• Custom Investment Criteria: Users can set parameters to align with their investment goals.
• Personalized Stock Recommendations: Our system analyzes market data to suggest stocks that match user preferences.
• Real-Time Data: Live stock information is sourced from reliable APIs, offering up-to-date market insights.
• Engaging UI: A sleek, modern interface that emphasizes usability and aesthetic appeal.

Discover how StockMatch can enhance your investment strategy by visiting our live site: StockMatch.

(back to top)

Demo Video

Watch the StockMatch application in action:

StockMatchFinal.mp4

Demo Images

Figure 1: Login with Google screen on mobile

Figure 2: Home screen on mobile

Figure 3: Users watchlist screen on mobile

Built With

• 

• 

• 

• 

• 

• 

(back to top)

Powered By

Getting Started

This guide will outline the steps necessary to set up StockMatch environment with Go, Python, Spring/Java backend, and a React frontend. Follow these instructions to prepare your local development environment.

Prerequisites

Before you begin, ensure you have the following installed:

• Go: Download and install from the official Go website.

• Python: Download and install from the official Python website.

• Node.js and npm: npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js and npm from the official Node.js website.

Installations and Setups

Go Installation

1. Confirm Go installation by checking the version in your terminal:

   go version

Python Installation

1. Confirm Python installation by checking the version in your terminal:

   python --version
   # or for Python 3
   python3 --version

Spring / Java Setup

1. Download and install the Java Development Kit (JDK) from Oracle or use an OpenJDK distribution.
2. Download and install Maven from the official Apache Maven project website.
3. Configure environment variables for Java and Maven if needed.

Project Installation

1. Clone the repositories:

   git clone https://github.com/Aryanpatel335/StockMatch.git

2. Install dependencies for the Spring/Java application:

   cd StockMatchBackend
   mvn install

3. Install NPM packages for the React frontend:

   cd frontend
   npm install

Running the Application

1. Start the Spring/Java server:

   cd StockMatchBackend
   mvn spring-boot:run

   The server should be accessible at http://localhost:8080.

2. In a new terminal, launch the React frontend:

   cd frontend
   npm start

   The React app should now be available at http://localhost:3000.

You are now ready to run and contribute to StockMatch!

(back to top)

Usage

Try it out: https://stockmatch.netlify.app/

Roadmap

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

Contributing

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)

Contacts

• Aryan Patel:
  • Personal: aryanp862002@gmail.com
  • School: patea156@mcmaster.ca

---

• Martin Ivanov:
  • Personal: martinivnv2002@gmail.com

---

• Areez Visram:
  • Personal: areez.visram@gmail.com

---

Project Link: https://github.com/Aryanpatel335/StockMatch

Live Link: https://stockmatch.netlify.app/

(back to top)