Documentation & Formatting Changes
Co-Authored-By: svedev <28451791+svedev0@users.noreply.github.com>
This commit is contained in:
parent
8c23c68565
commit
f542df17ab
12 changed files with 345 additions and 69 deletions
|
|
@ -1,15 +1,32 @@
|
|||
# websocket
|
||||
# Websocket Server
|
||||
|
||||
To install dependencies:
|
||||
This is the websocket server component of Rugplay, built with [Bun](https://bun.sh) - a fast all-in-one JavaScript runtime.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Bun](https://bun.sh) (v1.2.11 or later)
|
||||
- [Redis](https://redis.io/downloads/) running in the background
|
||||
|
||||
## Development
|
||||
|
||||
### Initial Setup
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
To run:
|
||||
### Running the Server
|
||||
|
||||
```bash
|
||||
bun run src/main.ts
|
||||
```
|
||||
|
||||
This project was created using `bun init` in bun v1.2.11. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
||||
## Production
|
||||
|
||||
For production deployment, you do not need to start the WebSocket server separately. Simply run `build.sh` in the main directory, and the WebSocket server will be included as part of the deployment process.
|
||||
|
||||
## Notes
|
||||
|
||||
- This project was created using `bun init` in bun v1.2.11
|
||||
- The websocket server handles real-time updates for the trading platform
|
||||
- Make sure Redis is running before starting the server
|
||||
|
|
|
|||
Reference in a new issue