SacHacksVI_TheCowsOverYonder

A Gamified Stock Market Simulator made for SacHacks VI

Instruction Manual

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/SacHacksVI_TheCowsOverYonder.git

2. Navigate to the project directory:

   cd SacHacksVI_TheCowsOverYonder

3. Install the required dependencies:

   npm install

Usage

1. Start the frontend application:

   npm run dev

2. Open your web browser and go to http://localhost:5173.

Starting the Backend

1. Navigate to the backend directory:

   cd backend

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:
   • On Windows:

     venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

4. Install the required dependencies:

   pip install -r requirements.txt

5. Start the backend server:

   flask run

Features

• Real-time Stock Prices: Get the latest stock prices updated in real-time.
• Portfolio Management: Manage your stock portfolio and track your investments.
• Gamification: Earn points and badges as you trade and achieve milestones.

Contributing

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-branch

3. Make your changes and commit them:

   git commit -m "Add new feature"

4. Push to the branch:

   git push origin feature-branch

5. Create a pull request.

License

This project is licensed under the Apache 2.0 License.