StockPortfolio

Simple Stocks and Dividend Tracker

📝 Table of Contents

• 📝 Table of Contents
• 🏁 Getting Started
• Folder Structure
• Prerequisites
• Installation
• 🎈 Usage
• ⚡ UI
• Current Issues
• Authors
• Credits/Citation

🏁 Getting Started

This project will help a individual manage all of their investmnents and help them make educated guesses to predict the next best stock to increase their dividend output.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Folder Structure

• k8s/
• willow/
  • nginx/
• willow_api/

The 2 main microservices of the project are the Frontend which is the willow folder and is made with react. The second microservice is the backend made with Golang and is called willow_api. The k8s folder contains all the Dev Ops configuration related to kubernates

Prerequisites

What things you need to install and run the application

• docker -> https://docs.docker.com/get-docker/
• kubectl -> https://kubernetes.io/docs/tasks/tools/
• minikube -> https://minikube.sigs.k8s.io/docs/start/
• code editor -> https://code.visualstudio.com/

🎈 Usage

run the frontend and backend with docker

on Linux

make build

on Windows

docker-compose up --build

• Navigate to localhost:3000 on your favorite browser

Docker images

Frontend -> willow

vaishvik7568/willow

Backend -> willow_api

vaishvik7568/willowapi

Run the Application with Kubernetes

see documentation this README.md

⚡ UI

Images coming soon

Starting dashboard

Main page to add stocks

NavBar

Ligh/Dark mode

Usage and Contribution

Current Issues

1. Add Jenkins and Ansible
2. Add more test
3. Add ML to predict stocks

Authors

• Vaishvik Maisuria