A simple messaging program and API
Project description
TuiChat
A simple messaging program
Table of Contents
-
Installing
-
User's manual
-
Configuration
-
Other info
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development. See deployment for notes on how to deploy the project on a live system.
Installing (в„–1) compiled files
Go to releases
Download zip archive with files and unzip it to any directory
Installing (в„–2) from sources
Setup Git and type in git bash:
git clone https://github.com/Kukree/tuichat
Install Python 3 if not installed or compile program files with your program to compile (Pyinstaller, wheel, etc), the following lines are a program compilation guide
Installing (в„–3) compilation guide
Go to program directory
Run the following commands one at a time in your shell:
pip install pyinstaller
pyinstaller --onedir --onefile server.py
pyinstaller --onedir --onefile client.py
User's manual (host, or server holder)
Configure
Enter settings into config.json file and save it
config.json
Note: If you have problems with configuring, look at configuration file description
Note 2: If you don't want to use config.json you can delete it and configure program at startup
Running
Run server.exe (on info table you will see information about your server, running port, limit of connections, external IP address, TUI graphics, logging and others)
Give your external IP address to clients and connection port, written in server info table
User's manual (client)
Run client.exe
Enter IP address of server and press ENTER
Enter connection port of server and press ENTER
Enjoy :)
Configuration file description
-
max_connections
- Variable used for set a limit of connections to server -
port
- Port to connect to your server, users will type it in client -
enable_log
(True/false) - Enable or disable saving logs of messages/connections or disconnections/other things, happened on server -
enable_ui
(True/false) - Enable or disable special UI symbols, like: logo, lines for highlighting system messages, borders around license block
Contributing
To get started...
Step 1
-
Option 1
- рџЌґ Fork this repo!
-
Option 2
- рџ‘Ї Clone this repo to your local machine using
https://github.com/Kukree/tuichat.git
- рџ‘Ї Clone this repo to your local machine using
Step 2
- HACK AWAY! рџ”Ёрџ”Ёрџ”Ё
Step 3
- рџ”ѓ Create a new pull request using
https://github.com/Kukree/tuichat/compare/
.
Built With
- Python - Programming language
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Evgeniy Kuleshov - Initial work - Greenfield
See also the list of contributors who participated in this project.
License
This project is licensed under the GNU GPLv3 - see the LICENSE file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.