Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 1.7 KB

README.md

File metadata and controls

71 lines (51 loc) · 1.7 KB

Stoxs

Portfolio Tracker app using Spring Boot and React.

Description

Stoxs is a web application designed to help users track their investment portfolios. It is built with a Spring Boot backend and a React frontend, providing a seamless and efficient user experience. This project uses a monorepo structure.

Features

  • Track multiple investment portfolios
  • Real-time updates on portfolio performance
  • User authentication and authorization
  • Responsive and user-friendly interface

Technologies Used

  • Backend: Spring Boot
  • Frontend: React, Tailwind CSS, Shadcn
  • Languages: TypeScript, Java, JavaScript, CSS, HTML

Getting Started

Prerequisites

  • Java 17 or higher
  • Node.js and npm
  • Spring Boot
  • A web browser

Installation

  1. Clone the repository: 
    git clone https://github.com/Gourav0028/Stoxs.git
  2. Navigate to the project directory: 
    cd Stoxs
  3. Install the frontend dependencies: 
    cd frontend
npm install
  4. Run the frontend: 
    npm run dev
  5. Run the backend: 
    cd ../backend
./mvnw spring-boot:run

Usage

  1. Open a web browser and go to http://localhost:5173 for Frontend and http://localhost:8080 for Backend.
  2. Start tracking your investment portfolios.

Deployment

The application is deployed at stoxs.vercel.app. The backend is deployed using Railway and the frontend is deployed using Vercel.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

Contact

For any inquiries or support, please contact Gourav0028.