Skip to content

Latest commit

 

History

History
246 lines (184 loc) · 9.72 KB

README.md

File metadata and controls

246 lines (184 loc) · 9.72 KB
Raw

Logo

MrMeet

Your one stop telebot uncle to solve your group's meetup needs
Explore our documentation »

View Demo

Table of Contents
  1. About The Project
  2. Roadmap
  3. Contact

About The Project

Level of Achievement

Gemini

Project Foreword

Meet Mr.Meet - your friendly singaporean uncle bot we envisoned to help organise group meetings more easily and be that naggy uncle we come to know and love to remind you of your dreaded deadlines and milestones! It is both a telegram bot and a web app for a visual overview

We hope to make a Telegram Bot that makes initiating and planning work or casual meetups more smooth sailing, and that can remind its users of objectives and milestones to prompt action-taking.

Problem Motivation

With many modules with project work in nus, students seem to have trouble keeping track of project deadlines, group’s milestones and also have trouble with initiating meetups with project mates.

Taking these into account, we realised, why not take this opportunity to solve that and also make initiating meetups more efficient and fun.

There are two parts to our solution.First a telegram bot with a singaporean uncle persona who produces meetup options and facilitate the project along the way.Second is a web app that helps to visualize the overview of the project that includes timeline and relevant links.

With this, we can make projects not only more efficient and fun but also you’ll never miss a deadline again.

User Stories

User

  • As a student who has many individual deadlines and submissions to keep track of, I want to be able to keep track of my project progress and future milestones easily.

  • As a student who has a very busy schedule, I want to be able to find common free times to work on projects with my group mates easily.

  • As a student who is shy and awkward, especially with people I have never met, I want to be able to have someone else that will help remind my group mates of objectives that need to be done soon.

  • As a person who wants to organise an event with friends, family and even colleagues, I want to be able to know which days would be best for everyone.

Admin

  • As an admin who manages the telegram bot and web app, I want to be able to add, update and delete any features to improve and update for better user experience.

Project Scope

The scope of our Orbital project can be broken down into 3 parts - Telegram Bot, Webapp and Extensions

Telegram Bot - Set Objectives, Meetups, Overview and Retrieving Login Details

Webapp - User Login, Dashboard

Extensions - Sync telegram bot and webapp, Calendar

Telegram Bot - Set Objectives and Milestones. Initiate Meetup. Overview and Retrieving Login Details

    • Set Objectives and Milestones

      Set up frontend - popup options and /objectives command to start setting up objectives.Create the flow of commands and responses for user experience

      Initate Meetup

      Find a common time for your group using the poll feature. Decided to split into three options - this week, next week and custom.

      Backend Database

      Set up database for objectives and login - keep track of the objectives and milestones.Create chat ID and password.Each group has one unique chat Id and password

      Retrieiving Login Details

      Click on /Webapp for unique chat Id and password given to each group.Convenient and easy

      Singaporean Uncle Persona

      User experience - incorporate singlish into the responses to make it fun

    • Webapp - User Login, Dashboard

      User Login

      Simple Chat Id and Login using the details from /webapp from telegram bot

      DashBoard - Icon

      MrMeet Icon to redirect to telegram Bot

      Dashboard - Overview of Objectives

      User can add or edit their objective details.Includes a popout calendar for datelines

      DashBoard - Add or edit milestones

      User can add or edit their milestones in each objectives.Includes a popout calendar for datelines

      Logout Button

      Users can logout to the Login page.

    Extensions - Sync telegram bot and webapp, Calendar, Notifications

    • Backend - Sync objectives and meetings

      Objectives and Meetings are consistent between telegram bot and Web app

      Telegram Bot - Alerts

      Mr Meet alerts when there are 0 objectives

      Calendar

      Users can visulaise their meetings on the calendar under the meetings tab.

    • Built With

    (back to top)

    Roadmap

    Check out the webapp»
    • User Login Page
    • Telegram Bot - Create and edit objectives and miletones
    • Overview
    • ChatId and password ( Generating and retrieving)
    • Navigation bar
    • Webapp Objectives and Milestones frontend create and edit Feature
    • Sync project details to the common database
    • Calendar Feature

    (back to top)

    User Testing

    Check out the Testing Log»

    Integration of Key Technologies

    The Key Technologies of our Orbital project can attributed to 3 main key technologies - Python(Telegram Bot hosted by Heroku), mySQL(Hosted by db4free.net), HTML and PHP(Hosted by Replit)

    Import pymySQL import pymySQL.cursors

    Heroku - We initially used Replit to host our python console but switched to Heroku for 24/7 free hosting servcies unlike replit where it requires computer to be online.To connect to Heroku, we had to upload code to Github and connect Github Repository to Heroku.

    db4free.net - Provided us a database of ChatID and password that can be accessed remotely.

    Replit - We used replit to host .PHP files. Using the ChatID and password, we used PHP to connect the frontend to the database.

    Contact

    Darren Chang - [email protected]

    Cleon Liew - [email protected]

    (back to top)