diff --git a/README.md b/README.md index 956374f..6a972cf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,67 @@ # 📬 Inboxly – Open Source Messenger Platform -**Inboxly** is a standalone, real-time messenger platform designed for teams and products that need a fully integratable communications inbox — at both the **API level** and **code level**. Build a hosted messaging service or embed Inboxly directly into your app for seamless messaging experiences. +
+ +![Inboxly Banner](https://readme-typing-svg.herokuapp.com?font=Fira+Code&size=35&pause=1000&color=00BFFF¢er=true&vCenter=true&width=1000&lines=Welcome+to+Inboxly!;Open+Source+Messenger+Platform;Fully+Integratable+Inbox) + +[![OSCI Project Banner](https://i.postimg.cc/76mJvBmF/OSCI-Project-Banner.png)](https://postimg.cc/8JfzMb84) + +[![GitHub Stars](https://img.shields.io/github/stars/devayanm/inboxly?style=for-the-badge&logo=github&color=yellow)](https://github.com/YOUR_USERNAME/inboxly/stargazers) +[![GitHub Issues](https://img.shields.io/github/issues/devayanm/inboxly?style=for-the-badge&logo=github&color=red)](https://github.com/YOUR_USERNAME/inboxly/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/devayanm/inboxly?style=for-the-badge&logo=github&color=blue)](https://github.com/YOUR_USERNAME/inboxly/pulls) +[![GitHub Forks](https://img.shields.io/github/forks/devayanm/inboxly?style=for-the-badge&logo=github&color=green)](https://github.com/YOUR_USERNAME/inboxly/network) + +
+ +--- + +
+ +## 🌟 **Show Your Support!** + +
+ +
+ +### ⭐ **Star this Repository** ⭐ +*Help us reach more developers by starring this repo!* + +[![Star Repository](https://img.shields.io/badge/⭐_Star_this_repo-black?style=for-the-badge&logo=github)](https://github.com/YOUR_USERNAME/inboxly) + +### 📣 **Connect with Me** + +[![GitHub](https://img.shields.io/badge/Follow_GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/devayanm) +[![LinkedIn](https://img.shields.io/badge/LinkedIn-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/YOUR_LINKEDIN/) -> ⭐ Star this repository to support the project and attract contributors! +
--- -[![OSCI-Project-Banner.png](https://i.postimg.cc/76mJvBmF/OSCI-Project-Banner.png)](https://postimg.cc/8JfzMb84) -## 🎯 Vision +## 📋 **Table of Contents** +- [📌 Overview](#-overview) +- [🔑 Core Features](#-core-features) +- [🛠️ Tech Stack](#-tech-stack) +- [📁 Project Structure](#-project-structure-suggested) +- [🚀 Getting Started](#-getting-started-developer) +- [🤝 Contribution Guide](#-contribution-guide) +- [🌟 How to Contribute](#-how-to-contribute) +- [👥 Contributors](#-contributors) +- [📄 License](#-license) +- [🙏 Acknowledgments](#-acknowledgments) + +--- + +## 📌 **Overview** + +**Inboxly** is a standalone, real-time messenger platform designed for teams and products that need a fully integratable communications inbox — at both the **API level** and **code level**. Build a hosted messaging service or embed Inboxly directly into your app for seamless messaging experiences. + +🎯 **Vision:** Inboxly provides a modern, secure, and extensible messaging inbox that supports direct messages, group chats, threading, message search, and attachments — all while being self-hostable and easy to integrate into existing codebases. --- -## 🔑 Core Features +## 🔑 **Core Features** ### Messaging - 1:1 direct messages and group chats @@ -51,7 +99,7 @@ Inboxly provides a modern, secure, and extensible messaging inbox that supports --- -## 🧰 Tech Stack +## 🛠️ **Tech Stack** | Layer | Technology | |-----------|-----------------------------------| @@ -66,7 +114,7 @@ Inboxly provides a modern, secure, and extensible messaging inbox that supports --- -## 🗂 Project Structure (suggested) +## 📁 **Project Structure (suggested)** ``` /inboxly @@ -101,26 +149,27 @@ Inboxly provides a modern, secure, and extensible messaging inbox that supports --- -## 🚀 Getting Started (Developer) +## 🚀 **Getting Started (Developer)** + +### Prerequisites +- Node.js & npm / yarn +- MongoDB instance +- Code editor (VS Code recommended) -1. Clone repo +### Installation ```bash -git clone https://github.com/YOUR_USERNAME/inboxly.git +# Clone repo +git clone https://github.com/devayanm/inboxly.git cd inboxly -``` -2. Install -```bash +# Install dependencies npm install # or yarn install -``` -3. Configure -```bash +# Configure environment variables cp .env.example .env -# add MONGODB_URI, JWT_SECRET, STORAGE_PROVIDER, etc. -``` +# set MONGODB_URI, JWT_SECRET, STORAGE_PROVIDER, etc. 4. Run ```bash @@ -134,26 +183,136 @@ Open `http://localhost:3000` (or configured port) to view the app. --- -## 🤝 Contribution Guide (short) +## 📋 **Contribution Guidelines** + +### 🎯 **How to Get Started** + +1. **🍴 Fork the Repository** + ```bash + # Click the "Fork" button at the top right of this page + ``` + +2. **📥 Clone Your Fork** + ```bash + git clone https://github.com/YOUR_USERNAME/inboxly.git + cd inboxly + ``` + +3. **🌿 Create a New Branch** + ```bash + git checkout -b feature/your-feature-name + # or + git checkout -b fix/bug-description + ``` + +4. **⚡ Make Your Changes** + - Write clean, readable code + - Follow existing code style + - Test your changes thoroughly + +5. **💾 Commit Your Changes** + ```bash + git add . + git commit -m "✨ Add: Your descriptive commit message" + ``` + +6. **🚀 Push to Your Fork** + ```bash + git push origin feature/your-feature-name + ``` + +7. **🔄 Create Pull Request** + - Go to your fork on GitHub + - Click "New Pull Request" + - Fill out the PR template + - Wait for review! + +--- + +## 👥 **Contributors** + +
+ +### 🌟 **Hall of Fame** 🌟 + +We're grateful to all our amazing contributors who have helped make this project better! + +
+ +| Avatar | Name | Role | Contributions | +|--------|------|------|---------------| +| 🎯 |**Your Name Here**| 🌱**New Contributor** | *Contribute and see your name here!* | +| 🎯 | **Your Name Here** | 🌱 **New Contributor** | *Contribute and see your name here!* | + +
+ +[![Contributors](https://contrib.rocks/image?repo=devayanm/inboxly)](https://github.com/devayanm/inboxly/graphs/contributors) -- Fork → branch (`feat/` / `fix/`) → commit → PR -- Use Conventional Commits -- Add tests for backend logic where applicable -- Keep PRs focused and documented +**💡 Want to see your avatar here? [Contribute now!](#-how-to-contribute)** -Full contribution docs available in `CONTRIBUTING.md`. +
--- -## 🔐 Environment Variables (.env.example) -- `PORT` -- `MONGODB_URI` -- `JWT_SECRET` -- `STORAGE_PROVIDER` (local/s3) -- `S3_BUCKET` (if using S3) -- `S3_REGION` +## 🏆 **OSCI 2025 Guidelines** + +### 📋 **For Participants** + +#### ✅ **Do's** +- ✅ **Read documentation** thoroughly before contributing +- ✅ **Follow code style** and project structure +- ✅ **Write descriptive** commit messages +- ✅ **Test your changes** before submitting PR +- ✅ **Be respectful** and collaborative +- ✅ **Ask questions** if you're unsure about anything + +#### ❌ **Don'ts** +- ❌ **Don't spam** with multiple PRs for same issue +- ❌ **Don't copy code** without understanding +- ❌ **Don't make unnecessary** changes +- ❌ **Don't ignore** code review feedback +- ❌ **Don't forget** to update documentation when needed + +### 🎯 **Contribution Levels** + +| Level | Description | Points | Badge | +|-------|-------------|--------|-------| +| 🥉 **Beginner** | Fix typos, update docs, minor bug fixes | 5-10 | ![Beginner](https://img.shields.io/badge/Level-Beginner-green) | +| 🥈 **Intermediate** | Add features, improve UI/UX, performance | 15-25 | ![Intermediate](https://img.shields.io/badge/Level-Intermediate-blue) | +| 🥇 **Advanced** | Major features, architecture improvements | 30-50 | ![Advanced](https://img.shields.io/badge/Level-Advanced-red) | --- -## 📄 License -MIT License — free for open-source and commercial use. +## 📄 **License** + +This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details. + +--- + +## 🙏 **Acknowledgments** + +
+ +### 🌟 **Special Thanks** + +
+ +- 🎓 **[Open Source Connect India 2025](https://www.osconnect.org/)** - For supporting open source +- 🚀 **[GitHub](https://github.com)** - For hosting our code +- 👥 **Open Source Community** - For continuous support and contributions +- 💡 **All Contributors** - For making this project awesome + +### 💬 **Join Our Community** + +[![Discord](https://img.shields.io/badge/Join_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](#) +[![Telegram](https://img.shields.io/badge/Join_Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](#) + +--- + +### ⭐ **Don't forget to star this repository!** ⭐ + +**Made with ❤️ by [Devayan Mandal](https://github.com/devayanm) and the Open Source Community** + +![Footer](https://readme-typing-svg.herokuapp.com?font=Fira+Code&size=20&pause=1000&color=E50914¢er=true&vCenter=true&width=1000&lines=Thank+you+for+visiting!;Happy+Coding!+🚀;Star+⭐+if+you+like+this+project!) + + \ No newline at end of file