An open API service indexing awesome lists of open source software.

https://github.com/bragdond/betalink-chat

Betalink microservice in charge of the communication
https://github.com/bragdond/betalink-chat

Last synced: 2 months ago
JSON representation

Betalink microservice in charge of the communication

Awesome Lists containing this project

README

          

# BetaLink - Chat Service

BetaLink aims to simplify the process of connecting beta-testers with project owners seeking feedback on their applications or products. This microservice is part of the larger BetaLink ecosystem, focusing on managing conversations and messages between project owners and beta-testers for smoother communication and feedback gathering.

## Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

### Prerequisites

Requirements for the software and other tools to build, test and push
- [Go](https://go.dev/) (v1.18+)
- [Postgresql](https://www.postgresql.org/)
- [Docker](https://www.docker.com/) (optional, for containerized development)
- [Postman](https://www.postman.com/) or cURL for testing APIs

### Installing

Steps to set up the development environment:

Clone the repository:

````shell
git clone https://github.com/BragdonD/betalink-chat.git
cd betalink-chat
````

## Running the tests

Explain how to run the automated tests for this system

### Sample Tests

Explain what these tests test and why

Give an example

### Style test

Checks if the best practices and the right coding style has been used.

Give an example

## Deployment

Add additional notes to deploy this on a live system

## Built With

- Golang - Core programming language
- PostgreSQL - Database for persistent storage
- Swagger/OpenAPI - API documentation
- Docker - Containerization

## Contributing

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

## Versioning

We use [Semantic Versioning](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/PurpleBooth/a-good-readme-template/tags).

## Authors

- **Thomas DUCLOS** - [BragdonD](https://github.com/BragdonD)

See also the list of [contributors](https://github.com/BragdonD/betalink-testers/contributors) who participated in this project.

## License

This project is licensed under the [CC0 1.0 Universal](LICENSE.md)
Creative Commons License - see the [LICENSE.md](LICENSE.md) file for
details

## Acknowledgments

- Hat tip to anyone whose code is used
- Inspiration
- etc