Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maksim2498/simplechat
Simple terminal chat
https://github.com/maksim2498/simplechat
chat client server terminal
Last synced: about 2 months ago
JSON representation
Simple terminal chat
- Host: GitHub
- URL: https://github.com/maksim2498/simplechat
- Owner: Maksim2498
- License: mit
- Created: 2023-09-29T23:32:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-07T13:44:04.000Z (over 1 year ago)
- Last Synced: 2023-10-08T13:34:24.185Z (over 1 year ago)
- Topics: chat, client, server, terminal
- Language: Scala
- Homepage: https://hub.mos.ru/fominmv2498/simplechat
- Size: 210 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# Simple Chat
## Table of Contents
- [Table of Contents](#table-of-contents);
- [About](#about);
- [Building](#building);
- [Dowloading](#downloading);
- [Running](#running);
- [Documentation](#documentation).
## About
This is a simple terminal chatting application.
Project is created in self-education purposes and has no real-world use potential.
It consists of:
- [`Core`](./core/README.md) - utility library;
- [`Client`](./client/README.md);
- [`Server`](./server/README.md).
For more info on each of it's parts see links above.
## Requirements
**For running:**
- [Java 17+](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html);
**For building:**
- [Scala 3.3.1+](https://www.scala-lang.org/download/3.3.1.html);
- [SBT 1.9.5+](https://www.scala-sbt.org/download.html).
## Building
First, set your current working directory to the one in which this `README.md` file is located.
Second, simply execute the following command in your terminal:
```bash
sbt assembly
```
After this, if no errors where emitted, you should have the following artifacts built:
- `client/target/scala-/client-.jar` - client `jar` archive;
- `server/target/scala-/server-.jar` - client `jar` archive;
Replace ``, ``, and `` with appropriate versions.
## Downloading
***WIP***
## Running
First, locate built or downloaded `jar` archives and simply run them with a command like the following:
```bash
java -jar /path/to/achive.jar
```
## Documentation
- [Protocol](./docs/protocol.md);
- [Client](./client/README.md);
- [Client CLI](./client/docs/cli.md);
- [Client shell](./client/docs/shell.md);
- [Core](./core/README.md);
- [Server](./server/README.md);
- [Server CLI](./server/docs/cli.md);
- [Server shell](./server/docs/shell.md);
- [Code of Conduct](./docs/CODE_OF_CONDUCT.md);
- [Security](./docs/SECURITY.md).