NotebookAI

A powerful note-taking application to organize your thoughts and ideas.
View Demo · Report Bug · Request Feature

About the Project

NotebookAI is designed to help you organize your notes in an efficient and user-friendly manner. Whether it's for work, study, or personal use, our application provides a range of features to support your note-taking needs.

Here's why:

• Your time should be focused on creating something amazing. NotebookAI provides a streamlined interface that allows you to focus on taking notes and organizing your thoughts without unnecessary distractions.
• You should implement DRY (Don't Repeat Yourself) principles to the rest of your life. NotebookAI ensures that your notes are easily searchable and organized, saving you time and effort in the long run.

Built With

Demo

(back to top)

Getting Started

Installation

1. Clone the repo

git clone https://github.com/nafisk/notebookai.git

2. Install the dependencies by running npm i.
3. Create an OpenAI and a Pinecone account for API keys
4. Create an .env file, populated with the values specified in the .env.example file

Setting Up the Database

For this application, you can use MongoDB as your database provider. Follow this guide to set up MongoDB. Once your database is set up, you can push the schema defined in this repository to your database by running:

npm prisma migrate deploy

Running the Front End

To run the front-end code (in development mode), run:

npm run dev

• For production, build the code using npm build and then npm start to run off the build

(back to top)

Features

Note Management

• Create and Edit Notes: Users can create new notes and edit existing ones using a rich text editor
• Tagging System: Organize your notes with tags for easy searchability (currently being worked on)

User Authentication

• Secure Login: User authentication is managed using Clerk.
• User Profiles: Each user has a profile where they can manage their personal information.

Advanced Search

• Search Functionality: Users can search their notes by keywords, tags, or dates using Pinecone for enhanced search capabilities.

Theming

• Dark Mode: The application supports dark mode for comfortable note-taking in low-light environments.

(back to top)

License

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

(back to top)

Contact

Nafis Khan - LinkedIn · Email · Twitter

(back to top)