Skip to content

Latest commit

 

History

History
171 lines (138 loc) · 13 KB

README.md

File metadata and controls

171 lines (138 loc) · 13 KB

NoteMind AI Note-Taking App


OpenAI's GPT-3 (for AI-powered features) - An autoregressive language model that uses deep learning to produce human-like text Sequelize ORM - A promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite, and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication, and more MySQL - An open-source relational database management system PostgreSQL - PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. bcrypt is a password-hashing function Render (for deployment) - A platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud express-session - A session middleware for Express.js, used for handling user sessions MVC Architecture - A software design pattern for developing web applications. MVC is an acronym for Model, View, and Controller. The pattern isolates the application logic from the user interface, allowing for efficient code organization and separation of concerns Fetch - Another very common task in modern websites and applications is retrieving individual data items from the server to update sections of a webpage without having to load an entire new page. Quill - A powerful, rich text editor built for compatibility and extensibility Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine, used for building fast and scalable network applications Express.js - A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications Node Package Manager JavaScript - ES6 GitHub (for repository hosting and project management) - Provides hosting for software development and version control using Git Git (for version control) - A free and open-source distributed version control system University of New Brunswick The MIT License


Description

NoteMind AI is a state-of-the-art note-taking application that integrates the power of AI to transform how individuals capture, organize, and innovate through their notes. Designed for professionals, students, and anyone in between, NoteMind AI combines rich text editing, and advanced AI functionalities to offer a unique note-taking solution.

Collaborators of the project: Karen Bourgeois, Ikechukwu Mbanugo and Arnaldo Sepulveda.

Table of Contents

Demo

You can simply visit the link https://notemindai.onrender.com/.

Features

  • User Authentication: NoteMind ensures the security of your information with robust user authentication processes. Secure signup, login, and controlled API request for the user are the bedrock of our commitment to data privacy and security.
  • Summarize Content with AI: Cut through the noise with AI-driven summarization capabilities. NoteMind analyzes lengthy notes and presents concise, accurate summaries, enabling you to grasp key points quickly and efficiently.
  • Item Extraction with AI: Transform your notes into action with our intelligent item extraction feature. NoteMind automatically identifies and converts action points in your notes into tasks or reminders, streamlining your workflow and ensuring nothing gets missed.
  • Continue Writing with AI: Eliminate writer's block with the continue writing feature powered by AI. NoteMind offers intelligent writing suggestions, helping you to seamlessly continue your thoughts and ideas, fostering a fluid and natural writing experience.
  • Explain Content with AI: Deepen your understanding of complex topics with AI-powered explanations. NoteMind can elucidate difficult concepts within your notes, offering clear and concise explanations and enhancing your learning process.
  • Sentiment Analysis with AI: Gauge the tone and mood of your notes with AI-driven sentiment analysis. NoteMind evaluates the sentiment of your text, providing insights into the emotional undertone, which is invaluable for personal reflections or analyzing feedback.
  • Note Management: NoteMind offers a comprehensive solution for creating, editing, deleting, and categorizing notes with rich text formatting. Whether you're jotting down a quick idea or drafting a detailed report, our platform adapts to your needs.
  • Search and Filter: Find the information you need, when you need it. With robust search and filter capabilities, NoteMind makes navigating through your notes effortless, saving you time and enhancing your productivity.

These features collectively make NoteMindAI a powerful tool for anyone looking to enhance their productivity, learning, and collaboration through note-taking. By leveraging AI, NoteMindAI not only simplifies note management but also adds layers of intelligence that augment the user's capability to create, analyze, and share knowledge.

Technologies Used

  • Backend: Node.js, Express.js
  • Frontend: Fetch for smooth interactions
  • Database: MySQL, PostgreSQL, Sequelize ORM, bcrypt
  • Authentication: express-session, cookies, tokens
  • AI Services: OpenAI's GPT-3-turbo for AI-driven features
  • Deployment: Render with PostgreSQL

Getting Started

Prerequisites

Ensure you have the following installed before proceeding:

  • Node.js and npm
  • Git (for version control)
  • MySQL or access to a MySQL database service

Setup & Installation

  1. Clone the repository:
git clone https://github.com/naturuplift/NoteMindAI.git
cd NoteMindAI
  1. Install dependencies:
    npm install
  1. Set up environment variables:
  • Create the .env file.
  • Fill in the necessary environment variables.
  1. Start the application:
    npm start
  1. Visit the application in your browser:

Application Usage

  • Create an Account: Sign up to have access to application. NoteMindAI sign-up

  • Login into Account: Login to start creating notes. NoteMindAI login

  • View Dashboard: Use the dashboard to view your notes and select them by moving cursor then click over note title. NoteMindAI dashboard

  • Search and Filter: Find the information you need by navigating through your notes. NoteMindAI search

  • Create a New Note: To start working on a note click on button 'New Note' button. NoteMindAI create a new note

  • Create/Edit Notes: Use the rich text editor to jot down your thoughts or meeting minutes. NoteMindAI editor

  • AI features:: Use the Summary button to summarize note which condense long notes into digestible summaries. NoteMindAI summary

  • AI features:: Use the Explanation button to Explain note which deepen your understanding of complex topics with clear and concise explanations. NoteMindAI explain

  • AI features:: Use the Sentiment button to gauge the tone and mood of your notes. NoteMindAI sentiment

  • AI features:: Use the Writing button to continue writing which offers intelligent writing suggestions, helping you to seamlessly continue your thoughts and ideas. NoteMindAI writing

  • AI features:: Use the Action Item button to automatically identifies and converts action points in your notes. NoteMindAI action item

State Flow Diagram

For a visual representation of the sequence of actions involved in the AI-Powered Note-Taking App, refer to the Project Setup and Functionality and the State Diagram Collaborative Note-Taking App provided in the project documentation.

Contributing

Contributions to the NoteMind project are welcome!

  • Fork the project.
  • Create your feature branch (git checkout -b feature/AmazingFeature).
  • Commit your changes (git commit -m 'Add some AmazingFeature').
  • Push to the branch (git push origin feature/AmazingFeature).
  • Open a pull request.

License

Distributed under the MIT License. See LICENSE for more information.