Skip to content

Latest commit

 

History

History
134 lines (110 loc) · 5.77 KB

README.md

File metadata and controls

134 lines (110 loc) · 5.77 KB
Raw

JTalker
JTalker

An implementation of a server/client application in Java.

GNU GPL v3.0 Contributor Covenant v1.4 Codacy Travis CI Docs Follow on Twitter Gitter Say Thanks!

Description • Testing • Deployment • Built With • Versioning • Authors • License • Acknowledgments

JTalker

An implementation of a server/client application in Java. This started as an example application for a networking class. However, we wanted to expand on it and test a couple things out. The only real use for JTalker is as an example of a server/client text sender, and to be used concurrently with a packet sniffer such as Wireshark.

Getting Started

See Installing to install JTalker for use or testing purposes. See Deployment for notes on how to deploy the project on a live system.

Prerequisites

You need the Java™ Runtime Environment version 9 to use JTalker. However, to build JTalker, you need the Java™ Development Kit version 9 in order to use the javac command. However, if you wish to build the docs, you must have version 11 or later.

Installing

We will give you an entire rundown on how to install JTalker. If you wish to build the system by hand, here are the steps you will take. The first step is cloning the repository:

git clone https://github.com/coswald/JTalker

Once you have done that, move into the JTalker directory and make the project.

cd JTalker
make all

The all is optional. TODO: Generate a test to test the system works.

Tests

We use Travis CI for tests and testing hooks. Currently, the only test we have for JTalker is to see if the project make script works. Check the travis config file for further developments and a more accurate idea of what scripts are run.

Example tests

TODO: Generate JTalker tests.

And coding style tests

We use Codacy for our style checking tests. Check the above listing to see how we are! Note that we have made custom hooks and rules for this project. Our coding style is well defined, and keep updated for documentation on this.

Deployment

Deployment has two steps. Once the project is completed, a more detailed listing of how this will work can be described. But there are two different types of deployment: Server and Client.

Server Deployment

TODO: Generate JTalker server deployment guide.

Clint Deployment

TODO: Generate JTalker client deployment guide.

Built With

  • javac - The java compiler

Contributing

Please read the CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Coved William Oswald - Lead Programmer - coswald

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU GPL v3.0 License - see the LICENSE.md file for details.

Acknowledgments

  • Thank you to Dheryta Jaisinghani for the inspiration to start this project, as well as her guidance during this process.
  • Thank you to PurpleBooth, for letting us use their README style!
  • Thank you to Twitter Archive, for letting us use their coding style template!