Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 2.92 KB

README.md

File metadata and controls

66 lines (41 loc) · 2.92 KB
Raw

Noteflow

Description

NoteFlow is a web-based dynamic note-taking application built using React, designed to enhance the user's note creation and management experience. The project seamlessly combines user-friendly features and technology to facilitate efficient note-taking and preservation. Local Storage is employed to manage data persistence and retrieval.

Demo

You can try out a live demo of this project here.

Notes App Notes App

Table of Contents

Installation

To run this project locally, follow these steps:

  1. Clone this repository.
  2. Navigate to the project directory.
  3. Run npm install to install dependencies.
  4. Run npm run dev to start the development server.

Usage

  • Create new notes easily.
  • Edit and update existing notes.
  • Organize your notes efficiently.

Key Features and Achievements

  • Note Creation and Editing: Implemented a versatile editor component that allows users to create and edit notes in Markdown format, providing a streamlined interface for content generation.

  • Intuitive Sidebar: Designed an intuitive sidebar for efficient note management. Users can select and interact with their notes, offering an organized workspace for effective note access.

  • Data Persistence: Ensured data persistence with the use of the browser's local storage. Notes are securely saved and retrieved between sessions, safeguarding user data.

  • Markdown to HTML Conversion: Leveraged the "Showdown" library to seamlessly convert Markdown notes into HTML format, enhancing the readability and presentation of notes.

  • User-Friendly Layout: Incorporated a flexible split-view layout, enabling users to adjust the size of the sidebar and editor components to suit their preferences, further enhancing the user experience.

Technologies and Methods

  • React: Used for building the frontend of the web application.
  • Local Storage: Employed to manage data persistence and retrieval.
  • Markdown: Utilized as the primary format for note creation.
  • "Showdown" Library: Integrated to convert Markdown to HTML for better note presentation.
  • Responsive Design: Ensured that the application works seamlessly on different devices.

Developer