Neko Notes 📝

Welcome to Neko Notes, where note-taking meets magic! 🚀

Table of Contents

Introduction

Neko Notes is not your average note app; it's a productivity companion that makes capturing ideas a breeze. With a sleek design and powerful features, it's tailored for users who value both simplicity and functionality.

Features

🖋️ Rich Text Editor

Say goodbye to plain text! Our editor empowers you to express yourself with a rich set of formatting options. Bold, italicize, underline, and even add lists effortlessly.

🚀 AI Summarization

Let our AI do the heavy lifting! Summarize your lengthy notes into concise snippets, making information digestion quick and easy.

🌐 Translation Capabilities

Break language barriers! Translate your notes into different languages, opening up a world of possibilities for global collaboration.

❓ Context-Based Q&A

Need a quick refresher? Ask questions related to your notes, and our AI will provide context-based answers. It's like having a virtual study buddy!

Tech Stack

  • ReactJS: For the delightful front-end experience.
  • Flask and Go: Powering the robust back-end infrastructure.
  • HTML and CSS: Crafting the beautiful UI.
  • TailwindCSS: Adding a dash of style for that modern look.
  • MongoDB: For storing the data dynamically.
  • Docker:To create a container to maintain a constant environment on every system.

Getting Started with Docker

  1. Clone this repository.
  2. Navigate to the project root directory.
  3. Run the following Docker commands:
# Build the Docker image
docker build -t neko-notes .

# Run the Docker container
docker run -p 3000:3000 neko-notes

Usage

  1. Formatting: Use the toolbar for formatting options.
  2. AI Summarization: Click "Summarize" to condense your note.
  3. Translation: Explore different languages in the "Translate" section.
  4. Context-Based Q&A: Ask questions and receive insightful answers!

Contributing

Contributions are welcome! Feel free to open issues and pull requests. Let's make Neko Notes even more awesome together.We welcome contributions from anyone interested in improving Neko Notes.