Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 4.18 KB

README.md

File metadata and controls

105 lines (71 loc) · 4.18 KB
Raw
chat-summarizer-illustration

Smart Scheduling App

Smart scheduling app is an assistant tailored for meetings, reminders, and schedules. It is connected with Google Calendar via function calling so you can query and create meetings directly from Rocket.Chat app.

smart-scheduler-app-icon

This app is initialized as a part of the Google Summer of Code 2024 program under the Rocket.Chat organization. See the original project description.

Contributor: Maria Khelli
Mentors: Sing Li, Devanshu Sharma, and Douglas Gubert

Features 🚀

To fully access the features of the Smart Scheduling App, you need specify variables for the Oauth2.0 as follows.

image

You can find the client ID and client secrets from Google Cloud Console.

Feature 1: Ask a question

smart-scheduler-app-icon

You can ask a question regarding someone's schedule by triggering /schedule ask [the_question]

Feature 2: Creating a meeting

smart-scheduler-app-icon

To create a meeting, you have to trigger /schedule and a pop up modal will appear. You have to specify the prompt and the participants of the meeting.

If you are not happy with the preference, you can redo it by using /schedule retry. However, if you still unsatisfied, you can pick the time manually by using /schedule pick.

Example prompt: Could you arrange a meeting for the next Wednesday? We need to discuss about the new AI projects, and I would prefer an early slot for fresher mind.

Feature 3: Setting a reminder

smart-scheduler-app-icon

Setting a reminder is similar to the previous one, you have to trigger /schedule and a pop up modal will appear and you have to fill the form. Unlike the previous one, this feature does not care about the schedule of the participants.

Example prompt: Remind me 23 September 2024 for a GSOC submission at 09.00

How to set up 💻

  1. Have a Rocket.Chat server ready. If you don't have a server, see this guide.
  2. Install the Rocket.Chat Apps Engline CLI. 
    3. npm install -g @rocket.chat/apps-cli

    Verify if the CLI has been installed

    rc-apps -v
  3. Clone the GitHub Repository
    4. git clone git@github.com:RocketChat/Apps.Smart.Scheduler.git
  4. Install app dependencies
    5. cd Apps.Smart.Scheduler
npm install
  5. Deploy the app to the server 
    6. rc-apps deploy --url <server_url> --username <username> --password <password>
    • If you are running the server locally, the default server_url is http://localhost:3000.
    • username is the username of your admin user.
    • password is the password of your admin user.

Additional Notes ✍️

The development of this app is done using Ollama. If you want to use other API, you might have to change the code accordingly.

Support us ❤️

If you like this project, please leave a star ⭐️. This helps more people to know this project.