Skip to content

Latest commit

 

History

History
75 lines (42 loc) · 2.34 KB

README.md

File metadata and controls

75 lines (42 loc) · 2.34 KB
Raw

SpyInvest

Welcome to SpyInvest, where you have a license to invest!

Overview

SpyInvest is a powerful investment management tool that allows users to create and manage multiple portfolios. Within each portfolio, users can add various assets, and the application will fetch real-time market prices using APIs. With SpyInvest, you can effortlessly monitor the performance of your investments, including total profit and loss for all your portfolios, as well as detailed insights into individual assets.

Demo

  1. Silent Demo - link
  2. Makers DemoDay - link

Features

  • Multiple Portfolios: Manage several portfolios, each with its own set of assets.
  • Real-Time Market Data: Get up-to-date market prices for your investments.
  • Comprehensive Reporting: View total profit and loss across all portfolios, as well as detailed performance metrics for each individual asset.

Installation

To install and run the application locally, please follow these steps:

1. Clone the Repository

Clone the repository to your local machine using the following command:

git clone https://github.com/olnov/spyinvest

2. Install Dependencies

Navigate to the FrontEnd directory and install the required packages:

cd ./FrontEnd
npm install .

Next, navigate to the API directory and install the backend dependencies:

cd ../API
npm install .

3. Seed the Database

To seed the database with initial data, run the following commands:

node ./seed.js
node ./seedAssets.js

4. Set Up Environment Variables

You will need to create relevant secret keys for both the FrontEnd and BackEnd. Please refer to dotenv's documentation for more information on how to configure environment variables.

5. Start the Application

Start the backend server:

npm start

Then, in a new terminal, start the frontend development server:

cd ../FrontEnd
npm run dev

The application should now be up and running on your local machine.

Contributing

We welcome contributions! Please fork the repository and submit a pull request for any features, bug fixes, or improvements.

License

This project is licensed under the MIT License.

Enjoy using SpyInvest, and may your investments flourish!