README.md

Crypto Trading Simulator

Built with ❤️ by Silas, Golo, Pius and contributors

---

The aim of this web application is to deliver an authentic cryptocurrency trading experience. We strive to enable our users to engage in a realistic and risk free trading environment which is synced to the latest exchange rates.

Please note that this is a prototype, which means certain processes are yet to be optimised. Nevertheless, we are proud to present a fully functional papertrading experience with more than 10 supported currencies - and more to come.

💰 How it works

Users will receive their initial start-off funds of 10,000 dollars right after registration. From thereon you are free to invest in our supported cryptocurrencies by selling or buying at your leisure. Strategic decisions are supported by our individual trading charts and exchange history. By practising with our simulation, you are able to gain vital knowledge and try out your own strategy first-hand, before even investing a cent of real money.

⚒️ Setup your own PaperCoin instance

Below is the procedure on how to set up your own PaperCoin instance.

Prerequisites

Before you start, you need already installed software. To be specific

• Node.js (nodejs.org/de/download/)
• MongoDB (www.mongodb.com/try/download/community)

Installing modules

Es gibt drei Ordner, die du benötigst, um PaperCoin zu installieren und zu starten.

By typing cd frontend/ from the root folder you can navigate to the frontend directory. Run npm ci to install the required modules located in the package-lock.json.

Repeat the same procedure for the modules in the backend folder.

Run the application

To start PaperCoin, you need to run the following commands in the three directories.

1. The directory mongodata is for the database stuff. Start the database instance with mongod --dbpath mongodata/ and specify the folder as an argument.
2. The directory backend contains the entire Express backend with connection to the database execute the command npm run start here.
3. In the directory frontend execute the command npm run start. This folder contains the entire React frontend.

Default application links

• The backend ist running on localhost:8080
• The frontend ist running on localhost:3000

⚙️ Built with MERN stack

• MongoDB - The database to store your cryptocurrencies
• Express - The web framework used at the backend
• React - The web framework used at the frontend
• Node.js - The backend power

📜 License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details