https://github.com/pawvan/own_websocket_server_kotlin
https://github.com/pawvan/own_websocket_server_kotlin
custom dirty socket
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pawvan/own_websocket_server_kotlin
- Owner: pawvan
- Created: 2024-11-18T19:25:20.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T04:25:45.000Z (6 months ago)
- Last Synced: 2024-12-07T20:08:54.707Z (5 months ago)
- Topics: custom, dirty, socket
- Language: Kotlin
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
Here’s the README for your WebSocket client project:
---
# Kotlin WebSocket Client
This is a simple WebSocket client built in Kotlin using the **Ktor** framework. It connects to a WebSocket server, sends messages, and receives real-time responses.
## Features
- Establishes a WebSocket connection.
- Sends messages to a WebSocket server.
- Receives messages asynchronously.
- Handles graceful disconnection.
---
## Folder Structure
```
websocket-client/
├── src/ # Source code
│ ├── main/ # Main application code
│ │ ├── kotlin/ # Kotlin source files
│ │ │ ├── client/ # WebSocket client logic
│ │ │ ├── utils/ # Helper utilities
│ ├── test/ # Unit tests
├── build.gradle.kts # Build script for Kotlin
├── settings.gradle.kts # Gradle settings
├── README.md # Project documentation
├── .gitignore # Git ignore rules
```
---
## Prerequisites
- **Kotlin** 1.9+
- **Gradle** 7.0+
- **JDK** 11+
---
## How to Run
1. Clone the repository:
```bash
git clone https://github.com/isafcck/own_websocket_kotlin.git
cd websocket-client
```
2. Build the project:
```bash
./gradlew build
```
3. Run the application:
```bash
./gradlew run
```
---
## Testing
To run the unit tests:
```bash
./gradlew test
```
---
## Contributing
Feel free to submit issues or pull requests to improve the functionality.
---
## License
This project is licensed under the MIT License.
---
Let me know if you want this customized further!