https://github.com/tomasesquivelgc/note-taking-app

📝🗒Capture every idea, moment, and inspiration! This Advanced Note Taker lets you Create, Read, Update and Delete your notes and organizing them with the use of tags. They also support markdown. Give it a try!
https://github.com/tomasesquivelgc/note-taking-app

localstorage markdown material-ui notes-app react themes typescript

Last synced: 7 days ago
JSON representation

📝🗒Capture every idea, moment, and inspiration! This Advanced Note Taker lets you Create, Read, Update and Delete your notes and organizing them with the use of tags. They also support markdown. Give it a try!

• Host: GitHub
• URL: https://github.com/tomasesquivelgc/note-taking-app
• Owner: tomasesquivelgc
• License: mit
• Created: 2024-05-07T00:02:35.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-18T22:52:40.000Z (6 months ago)
• Last Synced: 2024-10-16T07:03:51.532Z (22 days ago)
• Topics: localstorage, markdown, material-ui, notes-app, react, themes, typescript
• Language: TypeScript
• Homepage: https://taupe-cupcake-dc5afd.netlify.app
• Size: 129 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  
Advanced Note Taker



# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Advanced Note Taker 

**Advanced Note Taker** is a simple application that lets the user create notes and organize them with the use of tags. Every note and tag is then saved inside the local storage for reading, updating and deleting. Furthermore, the body of the notes uses markdown to allow the user a more complete experience.

## 🛠 Built With 

### Tech Stack 



  
Vite

  
React.js

  
Typescript

  
Material UI



### Key Features 

- **Create, Read, Update and Delete Notes**

- **Add tags to your notes and display a list of all the available tags**

- **Use Markdown for your note's body**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://taupe-cupcake-dc5afd.netlify.app)

(back to top)


## 💻 Getting Started 

This app only requires a browser, but if you want to get a local copy up and running, follow these steps.

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git [email protected]:tomasesquivelgc/Note-Taking-App.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

(back to top)


## 👥 Authors 

👤 **Tomás Matías Esquivel**

- GitHub: [@githubhandle](https://github.com/tomasesquivelgc)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tomas-esquivel-dev/)

(back to top)


## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [X] **Custom themes**

- [ ] **Drag and drop**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project please give it a star and check out some of my other projects!

(back to top)


## 🙏 Acknowledgments 

I would like to thank my friends, family and beautiful girlfriend for always supporting me.

I would also like to thank WebDevSimplified and iconos8 for providing assets and resources.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)