https://github.com/srdjan/clob
A toy trading application
https://github.com/srdjan/clob
Last synced: 2 months ago
JSON representation
A toy trading application
- Host: GitHub
- URL: https://github.com/srdjan/clob
- Owner: srdjan
- Archived: true
- Created: 2020-09-02T18:24:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T11:32:37.000Z (over 1 year ago)
- Last Synced: 2025-02-07T14:03:45.502Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.86 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Toy Spacerocks Trading Application
A full stack application, using React for the frontend and NodeJS for services, implements a simple trading marketplace
for spacerocks! :)
It accepts orders via an REST API via the UI client and publishes realtime updates to all looged in clients as the orderbook state changes.
### Installation
## API
1) Start by cloning the repo locally and navigate to newly created folder:
```sh
git clone https://github.com/srdjan/clob.git
cd clob
```
2) Next, for API development change directory to ./api, install dependencies and build the project:
```sh
cd api/
npm install
npm run build
```
3) On a succesful build, try running tests:
```sh
npm run test:unit
```
for unit tests, or:
```
npm run test:accept
```
for acceptance tests.
## UI
For UI development change directory to ./ui, install dependencies and build the project:
```sh
cd ui
npm install
npm start
```
## To run the application
Use two different command shells. First start the services:
```
[clob]> cd api
[clob/api]> npm start
```
### ... and then the frontend:
```sh
[clob/api]> cd ../ui
[clob/ui]> npm start
```