Crypton

Create customizable cryptocurrency streams with your chosen pairs and track their price changes, total trade count, volume and more in realtime.

Features

• Track multiple crypto pairs concurrently
• Modify and delete streams at will
• Compare latest prices to historical data
• Manage websocket ticker subscriptions and unsubscriptions
• Export local stream lists to cloud
• Cached ticker prices to avoid extra requests
• Batch updates and throttling to avoid performance pitfalls
• Preview app features with guest account
• Access to streams across different devices with verified account
• Keep user logged in with JWT tokens
• Update user's email and password

How to run this APP locally

1. Install the project's dependencies by running npm install or your package manager's respective command inside the backend and frontend directories.
2. Create a .env file inside the backend directory and fill it with the necessary values in accordance with the examples provided in ./backend/.env.examples
3. Run the generate script with your package manager to generate the prisma database client and create the unique database indexes within the mongodb instance you configured earlier in the .env file.
4. Run the dev script within ./backend to launch the node js development server.
5. Run the dev script within ./frontend to launch the react development server.

Problems with US based servers and github hosted runners

US-based servers such as the ones used by github hosted runners will encounter a 'Restricted location' error when using Binance's .com API endpoint due to US user access restrictions. Use one of the following solutions to get around this problem:

1. Change the Binance API endpoint located at index.ts from .com to .us. Note: this is the easiest solution, but will reduce the amount of available currency pairs from 2000+ to around 500.
2. Deploy a self-hosted runner located outside the US and run this repo's actions with it.