Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 2.8 KB

README.md

File metadata and controls

80 lines (55 loc) · 2.8 KB
Raw

CataList - Markdown Notes Application

About

CataList is a markdown notes application that allows users to create, edit, and delete notes with support for markdown formatting. Users can also organize their notes using tags and filter notes based on titles or tags. All data is stored in the local storage of the user's browser, ensuring a seamless and personalized experience.

Features

  • Create and edit notes using markdown formatting.
  • Organize notes with tags for easy categorization.
  • Filter notes by title or tags to quickly find specific notes.
  • Delete individual notes or clear all notes from the application.
  • Data is stored in the user's browser local storage.
  • User-friendly interface with responsive design using React Bootstrap.

Built With

React Bootstrap Typescript React-Markdown

Preview

Installation

Follow these steps to set up and run CataList on your local machine:

  1. Clone the repository:
git clone https://github.com/TheNewC0der-24/CataList.git
  1. Navigate to the project directory
  2. Install the dependencies using npm:
npm install or npm install --legacy-peer-deps
  1. Start the development server:
npm run dev
  1. Open your web browser and visit http://localhost:5173 to use CataList.

Usage

  1. Creating Notes: Click on the "Create" button to create a new note. You can use markdown formatting for your note's content.

  2. Editing Notes: To edit an existing note, click on the note you want to edit and click Edit button. Make your changes and click the "Save" button.

  3. Adding Tags: You can add tags to your notes to categorize them. Simply enter comma-separated tags while creating or editing a note.

  4. Filtering Notes: Use the title and tags bar to filter notes by title or tags. The notes will be dynamically updated as you type.

  5. Deleting Notes: To delete a note, click on the note and then click the "Delete" button.

Contributing

Contributions are welcome! If you find a bug or have a feature suggestion, please open an issue on the GitHub repository. If you'd like to contribute code, fork the repository, create a new branch, make your changes, and submit a pull request.

Ideas for contribution

  • Adding Firebase
  • Improve UI

Link

https://cata-list.netlify.app/

Feel free to reach out if you have any questions or feedback. Happy note-taking with CataList! 📝