LIGHTNING PROTOCOL ⚡

Paper trading game. Buy and sell assets and trade cards speculating on the price of those assets.

Table of Contents

• Installation
• Usage
• Configuration

Installation

Requirements

• Node >=18.12.x
• PostgreSQL >=14.x

Dependencies

• React + ReactDOM
• MaterialUI
• NextJS
• Sass
• swr
• axios
• pg
• dotenv
• express
• bcryptjs
• Others...

Dev Dependencies

• TypeScript
• typescript-plugin-css-modules
• Others...

Usage

General

1. In /client and /server directories, run npm install script to install dependencies
2. In /client dir, copy config.example.ts, rename copy to config.ts and fill out (Reference)
3. In /server dir, example.env, rename copy to .env and fill out (Reference)
4. Create an account
5. Create an asset pool for your account
6. Initialize the writer to create contract types and contracts

More detailed steps TBD

Development

1. (Follow general steps)
2. In /client dir, run script npm run dev
3. In /server dir, run script npm run dev
4. In browser, open http://localhost:3001 to view client

Production

1. TBD

Scripts

Client Development

• npm run dev [NextJS] Hosts client in NextJS development mode on port 3001, fast reloads on file save
• other client scripts TBD

Server Development

• npm run dev [Express] Hosts express server on SV_PORT, fast reloads on file save
• other server scripts TBD

Production

• TBD

Configuration

Client - Config file (.ts) Configuration

• serverURL API server URL (default: http://localhost:3000)

Server - Environment File (.env) Configuration

• SV_PORT Server port (default: 3000)
• SV_SECRET Set to a random string of your choosing
• PG_HOST PostgreSQL ip address or domain name
• PG_PORT PostgreSQL server port
• PG_DB Name of PostgreSQL database to connect to
• PG_USER Username of database user
• PG_PW Password of database user
• CL_ORIGIN1 First origin domain for authenticated requests (default: http://localhost:3001)
• CL_ORIGIN2 Second (if required) origin domain for authenticated requests (default: http://127.0.0.1:3001)
• CMC_API_URL API URL for CoinMarketCap, used for realtime crypto market data (default: sandbox creds)
• CMC_API_KEY API Key for CoinMarketCap (default: sandbox creds)
• CC_API_URL Production API URL for CryptoCompare, used for historical crypto market data
• CC_API_KEY Production API Key for CryptoCompare (default: na-na nothing)