StockMate

This project aims to develop a stock market portfolio management system with features such as user registration and login, stock portfolio management, an email notification system, and more. The app will utilize Node.js and Cockroach DB for the backend and a free and open stock market API to retrieve stock price information. The project will follow coding standards such as a coding style guide, using a linter, writing unit tests, and proper documentation.

Prerequisites

Make sure you have installed all of the following prerequisites on your machine:

• Node(v18.13.0) - Download & Install Node.js
• CockroachDB(v22.2.8) - Download & Install CockroachDB
• PostgreSQL - Download & Install PostgreSQL

Generate API_KEY

• Alpha Vantage - Create API KEY
• Get Symbol - API
• Get Stock Data - API
• Get Stock History - API
• Stock Analysis - API

Environment Variables

To run this project, you will need to add the environment variables which is listed in .env.example file to your .env file, which will be placed in the .config/ directory.

Run Project Locally

Clone the project

$ git clone https://github.com/jainiljakasaniya/StockMate.git

Go to the project directory

$ cd StockMate

Install dependencies

$ npm install

Generate API Documentation

$ npm run docs

Start the server

$ npm start

Tech Stack

• Database: CockroachDB, PostgreSQL
• Server: Node.js, Express.js

Features

• API integration
• User registration and login
• User password forgot and reset using email notification
• Password security
• Stock search and historical data
• Email notification system