This project will focus on creating a mock stock trading desktop web application. Users can create an account to experiment with different investing and trading techniques to simulate a real trading environment.
Developing this app’s motivation is to promote healthy trading psychology and reduce risky strategies by introducing simulated risk and exercising discipline.
- MongoDB (NoSQL Database)
- Node & Express (Backend)
- React (Frontend)
- More information can be found in our Architecture wiki
- Real time stock market look up
- Buy and sell with real world prices
- Stock price predictions
- Improve of trading psychology
- Supports smaller sized devices such as tablets and iPads
The project can be obtained by either downloading directly via this GitHub repo or cloned by running the following command:
git clone https://github.com/csdoris/Group-7-Kimchi-Stonks.git
It is required that node is installed before running the following commands.
Firstly, we want to navigate into the backend folder to perform a clean install of our dependencies and start it up.
$ cd Group-7-Kimchi-Stonks/
$ cd backend/
$ npm ci
added XXX packages in Xs
$ npm start
[nodemon] 2.0.7
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node src/server.js`
Server currently listening to http://localhost:8080
Connection to MongoDB successful.
$ cd frontend/
$ npm ci
added XXX packages in Xs
$ npm start
Compiled successfully!
You can now view kimchi-stonks-app in the browser.
http://localhost:3000
Note that the development build is not optimized.
To create a production build, use npm run build.
Code style is enforced by ESLint and linting can be done by the following command:
npm run lint
API Keys are provided in an .env file
Navigate into the backend folder src/backend and run the following command:
npm test
For other developers who may want to contribute or create issues, please visit the following wiki links:
Found here