-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
55fe578
commit 4c36365
Showing
1 changed file
with
25 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,43 @@ | ||
| <br /> | ||
| # Kavka: Open-Source, Private & Secure Messenger | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/kavkaco"> | ||
| <img src="./docs/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
| Kavka is a secure, open-source messaging platform built on GoLang and adhering to Clean Architecture principles. It provides a robust, scalable, and privacy-focused foundation for developing private chat experiences, secure collaboration tools, or confidential messaging apps. | ||
|
|
||
| <h3 align="center">Private & Secure Messenger</h3> | ||
| ### Built for Privacy | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/kavkaco/Kavka-Core/tree/main/docs"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <div> | ||
| <a href="https://github.com/kavkaco/Kavka-Core/actions/workflows/build.yml"> | ||
| <img src="https://github.com/kavkaco/Kavka-Core/actions/workflows/build.yml/badge.svg" | ||
| </a> | ||
| <a href="https://github.com/kavkaco/Kavka-Core/actions/workflows/integration_test.yml"> | ||
| <img src="https://github.com/kavkaco/Kavka-Core/actions/workflows/integration_test.yml/badge.svg" | ||
| </a> | ||
| </div> | ||
| <div> | ||
| <a href="https://github.com/kavkaco/Kavka-Core/actions/workflows/unit_test.yml"> | ||
| <img src="https://github.com/kavkaco/Kavka-Core/actions/workflows/unit_test.yml/badge.svg" | ||
| </a> | ||
| <a href="https://github.com/kavkaco/Kavka-Core/actions/workflows/code_linter.yml"> | ||
| <img src="https://github.com/kavkaco/Kavka-Core/actions/workflows/code_linter.yml/badge.svg" | ||
| </a> | ||
| </div> | ||
| </p> | ||
| </div> | ||
|
|
||
| ## 💬 Kavka: Secure and Private Chat Application | ||
| Kavka is more than just a messenger; it's a commitment to your privacy. Every message you send is end-to-end encrypted, ensuring that only you and the intended recipient can read its contents. Our open-source code is transparent, allowing you to verify our security claims. With Kavka, you can communicate with confidence, knowing that your conversations are safe and secure. | ||
|
|
||
| Kavka is an open-source chat application designed for **secure** and **private** communication. Developed using GoLang and adhering to the **Clean Architecture** principles, Kavka offers a robust and scalable foundation for building private chat experiences. | ||
| ### Setup Development Server | ||
|
|
||
| ### 🦄 Built for Privacy | ||
|
|
||
| Kavka is designed with a focus on privacy at its core. Our goal is to provide a platform for small to medium-scale private chat applications that can be deployed on anonymous servers. Kavka utilizes **strong encryption algorithms** to ensure the confidentiality and anonymity of your messages, allowing users to express themselves freely without fear. | ||
|
|
||
| ### 🔑 Key Features | ||
| The server setup guide is explained in detail here. | ||
|
|
||
| - **Open-Source**: Kavka's source code is freely available for anyone to inspect, modify, and contribute to. | ||
| ```bash | ||
| git clone --depth 1 https://github.com/kavkaco/Kavka-Core.git | ||
| ``` | ||
|
|
||
| - **GoLang and Clean Architecture**: The application leverages the power and efficiency of GoLang, while adhering to the Clean Architecture principles for maintainability and scalability. | ||
| 2. Install dependencies | ||
|
|
||
| - **Strong Encryption**: Kavka utilizes strong encryption algorithms to safeguard message confidentiality and anonymity. | ||
| ```bash | ||
| go mod tidy | ||
| ``` | ||
|
|
||
| - **Anonymous Server Deployment**: The application can be deployed on anonymous servers, further enhancing user privacy. | ||
| 3. Edit configuration | ||
| ```bash | ||
| vim ./config/config.yml | ||
| ``` | ||
|
|
||
| ## 🪜 Built With | ||
| 5. Start services | ||
|
|
||
| [](https://skillicons.dev) | ||
| Lets build and start services with `docker-compose` | ||
|
|
||
| ## ⚙️ Setup Server Guide | ||
| ```bash | ||
| sudo docker-compose up -d mongo redis minio | ||
|
|
||
| The server setup guide is explained in detail here. | ||
| make dev | ||
| ``` | ||
|
|
||
| [docs/setup_server.md](https://github.com/kavkaco/Kavka-Core/blob/main/docs/setup_server.md) | ||
|
|
||
| ## 💎 Contribution! | ||
| ### Contribution! | ||
|
|
||
| Kavka welcomes contributions from developers around the world. We are committed to fostering a collaborative and inclusive community where everyone can contribute to the project's growth and development. | ||
|
|
||
| We invite you to explore Kavka, join our community, and contribute to building a secure and private communication platform for everyone.💜 | ||
| We invite you to explore Kavka, join our community, and contribute to building a secure and private communication platform for everyone. |