Welcome to Market Mock! Market Mock is a free, educational paper-trading platform designed to make learning about and practicing investing a fun experience. With game-like elements such as quests and leaderboards, users can enjoy the process of exploring the investment world.
- Paper Trading: Practice investing in a risk-free, educational setting.
- Quests: Guide users through the game, starting simple and becoming progressively challenging.
- Leaderboards: Foster a competitive and achievement-driven learning environment.
To get Market Mock up and running on your local machine, follow these steps:
- Install MySQL locally.
- Set up a MySQL user.
-
Clone the Repo: If you haven’t already, clone the repository to your local machine.
git clone https://github.com/your-username/market-mock.git -
Navigate to the Project Directory:
cd market-mock -
Install Dependencies:
npm install -
Configure the Project: Fill out the config.json file with the necessary information.
-
Start the Development Server:
npm run dev
Market Mock should now be running on your local development server!
Contributions are welcome! For guidelines on how to contribute, please refer to the Wiki.
This project is licensed under the MIT License - see the LICENSE file for details.
Reid Hansell - reidhansell@gmail.com
For more information, questions, or discussions related to the project, feel free to reach out!
For more in-depth documentation, diagrams, and guidelines, check out the Market Mock Wiki.