/gRMS-client

CLI client of gRMS made completely in Golang

Primary LanguageGoGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

gRMS-client

gRMS is a fully fledged messaging service written in golang
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

gRMS-client is the client application for gRMS messaging service.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • Go 
    sudo apt install golang

Installation

  1. Get host address 
    example: 192.168.0.1:8080
  2. Clone the repo 
    git clone https://github.com/veryshyjelly/gRMS-client.git
  3. Build the project 
    go build
  4. Run the project 
    ./gRMS-client
  5. Enter host address

(back to top)

Usage

This app can be used to host a messaging service on you local network, as well as on the cloud. Just run the server and enter the ip address in the client and get hooked-up.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • add sign up option
  • P2P file transfer

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ayush Biswas - @veryshyjelly - veryshyjelly@gmail.com

Project Link: https://github.com/veryshyjelly/gRMS-client

(back to top)

Acknowledgments

(back to top)