Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/veryshyjelly/grms-client
CLI client of gRMS made completely in Golang
https://github.com/veryshyjelly/grms-client
chatapp cli go golang websocket
Last synced: 20 days ago
JSON representation
CLI client of gRMS made completely in Golang
- Host: GitHub
- URL: https://github.com/veryshyjelly/grms-client
- Owner: veryshyjelly
- License: gpl-3.0
- Created: 2023-03-04T20:43:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T14:53:50.000Z (about 1 year ago)
- Last Synced: 2023-10-06T15:44:21.664Z (about 1 year ago)
- Topics: chatapp, cli, go, golang, websocket
- Language: Go
- Homepage:
- Size: 14.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
gRMS-client
gRMS is a fully fledged messaging service written in golang
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
gRMS-client is the client application for gRMS messaging service.
## 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
```sh
sudo apt install golang
```
### Installation
1. Get host address
```sh
example: 192.168.0.1:8080
```
2. Clone the repo
```sh
git clone https://github.com/veryshyjelly/gRMS-client.git
```
3. Build the project
```sh
go build
```
4. Run the project
```sh
./gRMS-client
```
5. Enter host address
## 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](https://example.com)_
## Roadmap
- add sign up option
- P2P file transfer
See the [open issues](https://github.com/veryshyjelly/gRMS/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Ayush Biswas - [@veryshyjelly](https://twitter.com/veryshyjelly) - [email protected]
Project Link: [https://github.com/veryshyjelly/gRMS-client](https://github.com/veryshyjelly/gRMS-client)
## Acknowledgments
* [Go-React-Chat-App](https://github.com/AkhilSharma90/GO-React-Fullstack-Chat)
[contributors-shield]: https://img.shields.io/github/contributors/veryshyjelly/gRMS-client.svg?style=for-the-badge
[contributors-url]: https://github.com/veryshyjelly/gRMS-client/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/veryshyjelly/gRMS-client.svg?style=for-the-badge
[forks-url]: https://github.com/veryshyjelly/gRMS-client/network/members
[stars-shield]: https://img.shields.io/github/stars/veryshyjelly/gRMS-client.svg?style=for-the-badge
[stars-url]: https://github.com/veryshyjelly/gRMS-client/stargazers
[issues-shield]: https://img.shields.io/github/issues/veryshyjelly/gRMS-client.svg?style=for-the-badge
[issues-url]: https://github.com/veryshyjelly/gRMS/issues
[license-shield]: https://img.shields.io/github/license/veryshyjelly/gRMS-client.svg?style=for-the-badge
[license-url]: https://github.com/veryshyjelly/gRMS-client/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/veryshyjelly
[product-screenshot]: images/screenshot.png
[Go]: https://img.shields.io/badge/Golang-878787?style=for-the-badge&logo=go&logoColor=white
[Go-link]: https://golang.google.cn/
[Go-fiber]: https://img.shields.io/badge/%F0%9F%92%A1%20Go-Fiber-00ACD7.svg?style=flat-square
[Fiber-url]: https://github.com/gofiber/fiber