https://github.com/clementmadiot/markdown_supported_note-typescript

Markdown Supported Note Taking With Categories
https://github.com/clementmadiot/markdown_supported_note-typescript

Last synced: 12 days ago
JSON representation

Markdown Supported Note Taking With Categories

• Host: GitHub
• URL: https://github.com/clementmadiot/markdown_supported_note-typescript
• Owner: ClementMadiot
• Created: 2024-10-22T11:25:37.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T09:04:27.000Z (2 months ago)
• Last Synced: 2024-12-12T20:14:44.871Z (12 days ago)
• Language: TypeScript
• Size: 160 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  


      

      

      

  

  
Markdown Supported Note Taking With Categories



## 
 📋 Summary

- ✨ [Introduction](#introduction)

- 🔋 [Features](#features)

- 🛠 [Technology Used](#tech-stack)

- 🚀 [Launch App](#launch-app)

## 
 ✨ Introduction

**[ENG]** Welcome to my Markdown Supported Note Taking With Categories project! This application is designed to provide a flexible and efficient way to organize and manage your notes using Markdown syntax. With built-in support for categories, you can easily categorize your notes and quickly find the information you need.

**[FR]** Bienvenue dans mon projet de prise de notes avec prise en charge de Markdown et catégories ! Cette application est conçue pour vous offrir un moyen flexible et efficace d'organiser et de gérer vos notes en utilisant la syntaxe Markdown. Grâce à la prise en charge intégrée des catégories, vous pouvez facilement catégoriser vos notes et trouver rapidement les informations dont vous avez besoin.

## 🔋 Features

👉 **Markdown Support**: Write your notes using Markdown for rich formatting, including headings, lists, code blocks, and more.

👉 **Categories**: Organize your notes into categories to keep them well-structured and easily searchable.

👉 **Intuitive Interface**: Enjoy a user-friendly interface that makes note-taking a breeze.

👉 **Built with TypeScript**: The application is built using TypeScript for robust type safety and maintainability.

👉 **Bootstrap Styling**: Leverage Bootstrap for a modern and responsive design.

## 
 🛠 Technology Used

- [react-router-dom](https://www.npmjs.com/package/react-router-dom)

The react-router-dom package contains bindings for using React Router in web applications. Please see the Getting Started guide for more information on how to get started with React Router.

- [bootstrap](https://getbootstrap.com/)

Powerful, extensible, and feature-packed frontend toolkit. Build and customize with Sass, utilize prebuilt grid system and components, and bring projects to life with powerful JavaScript plugins.

- [react-bootstrap](https://react-bootstrap.netlify.app/docs/getting-started/introduction)

React-Bootstrap replaces the Bootstrap JavaScript. Each component has been built from scratch as a true React component, without unneeded dependencies like jQuery.

- [react-select](https://react-select.com/home)

A flexible and beautiful Select Input control for ReactJS with multiselect, autocomplete, async and creatable support.

- [uuid](https://www.npmjs.com/package/uuid)

The uuid package provides functionality for generating cryptographically secure, standard UUIDs with support for versions 1-6 UUIDs

- [react-markdown](https://www.npmjs.com/package/react-markdown/v/8.0.6)

React component that can be given a string of markdown that it’ll safely render to React elements. You can pass plugins to change how markdown is transformed to React elements and pass components that will be used instead of normal HTML elements.

## 
 🚀 Launch App

Follow these steps to set up the project locally on your machine.

**Prerequisites**

>[!NOTE]

> Make sure you have the following installed on your machine:

- [Git](https://git-scm.com/)

- [Node.js](https://nodejs.org/en)

- [npm](https://www.npmjs.com/) *(Node Package Manager)*

**Cloning the Repository**

```bash

git clone {git remote URL}

cd {git project..}

```

**Installation**

> After cloning the repository, run the command `npm i` or `yarn i` to install the project's dependencies.

_npm_

```

npm install 

```

_yarn_

```

yarn install

```

> Once the dependencies are installed, start the project with the command `npm run dev`.