Piper-kt

Piper-kt
Explore the docs »

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contact
• Acknowledgements

About the Project

Built With

Infrastructure

• Kubernetes
• Helm
• Docker
• Kafka

Kotlin Microservices

• Kotlin
• Micronaut
• MongoDB
• JWT
• Kotest
• Konsist
• Mockito
• Dokka
• Kover
• Testcontainers

Integrated Microservices

• NodeJS
• Typescript
• Express
• Mongoose

Frontend

• Vue.js
• Pinia
• Quasar

Communication

• Socket.io
• Axios
• WebRTC

Api Documentation

• Swagger

Code Quality

• Spotless
• Detekt
• Ktfmt

Versioning

• Conventional Commits
• Semantic Versioning
• Semantic Release

CI/CD

• GitHub Actions
• Docker Hub
• Gradle

Getting Started

To get a local copy up and running follow these simple steps.

For advanced details, check the documentation.

Prerequisites

• kubectl
• Helm
• a Kubernetes cluster (e.g. Minikube)

Installation

1. Clone the repository with the command

$ git clone https://github.com/zucchero-sintattico/piper-kt.git

2. Navigate to the folder

$ cd piper-kt

3. Run the deploy command to start the deployment process.

$ ./scripts/deploy.sh

Visit localhost:8080 to see the application running.

Contributing

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

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

License

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

Contact

Project Link: https://github.com/zucchero-sintattico/piperchat

Acknowledgements

• Alessandro Mazzoli
• Manuel Andruccioli
• Luigi Borriello
• Tommaso Patriti

Made with ❤️ in Italy