Skip to content

Latest commit

 

History

History
163 lines (111 loc) · 5.76 KB

README.md

File metadata and controls

163 lines (111 loc) · 5.76 KB
Raw

CopilotMate

image CopilotMate is an open-source personal assistant designed to streamline productivity with an intuitive interface and a suite of essential tools. Whether you're organizing your tasks, tracking expenses, or studying efficiently, CopilotMate has your back! Built using CopilotKit, it integrates seamlessly to help you stay organized and focused.

🛠️ Technologies Being Used

Next.js Tailwind CSS CopilotKit Framer Motion

  • CopilotKit (for AI functionalities)
  • Next.js (for the frontend)
  • Tailwind CSS (for styling)
  • Groq SDK (for language models)
  • Llama model (for AI coagents)

Watch video on YouTube

Screenshot

image image image image image image image image image image image

Blog

Read more about CopilotMate in our detailed blog posts:

  1. CopilotMate Blog
  2. CopilotMate Development Journey
  3. Also, don't forget to support on Twitter and Linkedin.

Table of Contents

Features

CopilotMate currently supports the following features:

  • To-Do Assistant: Create, update, and manage your tasks effortlessly.
  • Spreadsheet: Organize your data in a spreadsheet format.
  • Chatbot: Engage with a chatbot to answer your queries and assist in tasks.
  • Expense Tracker: Track and categorize your daily expenses with an improved dark-themed UI and glass effect for a sleek look.
  • StudyBuddy Coagent: A coagent that helps with study planning, note-taking, and quiz creation for focused learning sessions.

Upcoming Updates:

  • Calendar: Keep up with important dates and events (coming soon!).

What's New in v2.0?

  • StudyBuddy Coagent: Added a StudyBuddy tool for note-taking and quiz creation to boost your learning productivity.
  • Expense Tracker: Now available with a polished dark UI and glass effect to make tracking your expenses more enjoyable.
  • Improved UI/UX: Revamped interface for a smoother user experience and a more modern look.

Installation

Prerequisites

Steps

  1. Clone this repository:

    git clone https://github.com/yourusername/copilotmate.git

Running the Agent

First, install the dependencies:

cd agent
poetry install

Then, create a .env file inside ./agent with the following:

GROQ_API_KEY=...
TAVILY_API_KEY=...

Then, run the demo:

poetry run demo

  1. Navigate to the project directory:

    cd copilotmate

  2. Install the required dependencies:

    npm install

  3. Start the development server:

    npm run dev

  4. Open the app in your browser:

    http://localhost:3000

Usage

Once installed, you can access the following features:

  • To-Do Assistant: Navigate to /todo to manage your tasks. You can add, edit, mark complete, and delete tasks.

  • Spreadsheet: Access the spreadsheet at /spreadsheet to manage your data. Organize your records using rows and columns.

  • Chatbot: Go to /chatbot to interact with the AI-powered assistant for general queries and task automation.

  • Expense Tracker: Visit /expense-tracker to start tracking your expenses. The improved dark UI will keep you focused on your financials with style.

  • StudyBuddy Coagent: Head over to /studybuddy for study tools that help you plan, create quizzes, and organize notes effectively.

More routes and features are currently being developed.

Contributing

We welcome contributions from the community! To get started:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and test them thoroughly.
  4. Submit a pull request with a clear description of your changes.

Please refer to our Contributing Guide for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.