minhcord/README.md
2022-08-18 20:06:12 -04:00

22 lines
617 B
Markdown

# MINH_CORD
A wannabe discord clone but currently only support websocket real time chatting
## Dependencies
- `rust`
- `telnet`
## Installation
- Run `cargo build` at project root to build the binary.
## Running
### Development
- Run the server with `cargo run` or `RUST_LOG=debug cargo run` to run with debug.
### Production
- Run the binary with `minh_cord {LOCAL_IP_ADDRESS}`.
## Connecting to the server
- Get your local IP address of the machine you're running the server on: i.e `192.168.0.100`
- Run the server with the above commands.
- Run `telnet 192.168.0.100` from a client to connect to the server.