FinSim

Financial Simulator - Gamified Experience for Investment Learning

Instructions

1. Clone the repository:

   git clone https://github.com/Nate8888/FinSim.git

Running the Application

Backend Setup

Windows

1. Open Command Prompt.
2. Navigate to the backend folder:

   cd FinSim/backend

3. Activate a virtual environment:

   python3 -m venv venv # command could be python or python3 
   .\venv\Scripts\activate     # On Windows

4. Install the dependencies:

   python3 -m pip install -r requirements.txt # Make sure you are inside the backend folder

5. Run the Backend server:

   python3 main.py

MacOS

1. Open Terminal.
2. Navigate to the backend folder:

   cd FinSim/backend

3. Activate the virtual environment:

   python3 -m venv venv # command could be python or python3 
   source venv/bin/activate

4. Install the dependencies:

   python3 -m pip install -r requirements.txt

5. Run the Backend server:

   python3 main.py

Frontend Setup

1. Open a terminal or command prompt.
2. Navigate to the frontend/finsim folder:

   cd FinSim/frontend/finsim

3. Install the dependencies:

   npm install

4. Run the Frontend server:

   npm run dev

Committing Code Changes

1. Pull the latest changes from the main branch:

   git pull origin main

2. Checkout to a new branch based on the main branch:

   git checkout -b your-branch-name

3. Add your changes:

   git add .

4. Commit your changes:

   git commit -m "Your commit message"

5. Push your changes to the remote repository:

   git push origin your-branch-name