diff --git a/README.md b/README.md index f59a7c4..1a29170 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,55 @@ -# Kanbnize +

+ + Logo + + +## 📌 Introduction +- **Kanbanize** is a Chrome Web App that provides a one button click solution for a much better workflow management experience. -## Quick Start +- The app is easily accessible on all systems as it is built as a browser app. It has features such as creating kanban boards, adding, modifying and deleting kanban tasks, automatic creation of Zoom meetings links based on the title of the task, and automatic alerts on Whatsapp and Email with embedded meeting link before the start of the meeting. -``` -// Install dependencies for server & client -npm install +## 🔧 Tech Stack used -// Run client & server with concurrently -npm start +- ReactJS +- MongoDB +- express.js +- Twilio Whatsapp API (For Instant WhatsApp integration) +- Mailgun (For Instant email integration) +- Zoom SDK (to schedule Zoom call) -// Server runs on http://localhost:5000 and client on http://localhost:3000 +## 🤖 Starting Zoom within a card ``` +To automatically send a Zoom meeting to your Whatsapp and Email, +Type in a card : Zoom@AddYourMeetDescriptionName@2021-02-26T11:30:00Z (Time (in IST) and Date) +``` + + +## 📷 Video Demo + + ![gifgif](https://user-images.githubusercontent.com/58134096/109416623-6d1cae80-79e5-11eb-9e52-a004c429ac28.gif) + +## 🎯 Purpose of the Project + +- **Theme : Work from Home** Every tech firm uses multiple apps to help employees keep track of their progress. Since we are using separate ecosystems to do so, there is a lack of integration between the different ecosystems, which could hinder workflow and cause unnecessary problems. + +## 💻 Meet the makers + +Created with 💖 by Team ThreatLevelMidnight by Hariharan, Aaditya and Harish + +- Check out my Linkedin post for this project here! + + +## Contributing +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +**Future Roadmap** +- Create profile for individual users with different mail and Whatsapp number. (Right now, you have to manually input the number and email id) +- Integration with other communication platforms (Google Meet, Microsoft Teams) +- Publish the chrome app into Chrome Webstore +- Add Zoom call functionality into Jira Board + +## License +[MIT](https://choosealicense.com/licenses/mit/)