NoteNest is a modern and intuitive web application built with the MERN stack that allows users to create, manage, and organize their notes seamlessly. It comes packed with features such as CRUD operations, note pinning, rich text editing, search functionality, tag-based sorting, and a light/dark mode toggle.
- Create New Note: Add new notes with ease.
- Read Note: View existing notes.
- Edit Note: Update your notes as needed.
- Delete Note: Remove notes that are no longer needed.
- Pin notes to keep them at the top of your list for easy access.
- Write notes with a rich text editor that supports formatting, images, and more.
- Quickly find notes using the search functionality.
- Organize and sort your notes using custom tags.
- Toggle between light and dark modes for a comfortable viewing experience.
- Frontend: React, Tailwind CSS, Axios
- Backend: Node.js, Express.js, MongoDB
- Rich Text Editor: Quill
- NoteNest
- client
- dist
- node_modules (folder contents not shown)
- public
- src
- assets
- components
- pages
- utils
- App.css
- App.jsx
- index.css
- main.jsx .eslintignore index.html .gitignore package-lock.json package.json README.md postcss.config.json tailwind.config.js
- server
- models
- node_modules (folder contents not shown)
- .env
- app.js
- config.json
- gitignore
- package-lock.json
- package.json
- client
-
Clone the repository
git clone [https://github.com/your-username/NoteNest.git](https://github.com/Akshansh029/NoteNest-app.git)
-
Navigate to the project directory
cd NoteNest-app
-
Install dependencies for both client and server
cd client npm install cd ../server npm install
-
Create a
.env
file in the server directory and add your MongoDB URI and other environment variables:MONGO_URI=your-mongodb-uri PORT=5000
-
Start the development server
cd server npm run dev
-
Start the client application
cd ../client npm start
- Creating a Note: Click on the "New Note" button, fill in the details in the rich text editor, and save.
- Editing a Note: Click on the note you want to edit, make changes, and save.
- Deleting a Note: Click on the delete icon next to the note you wish to remove.
- Pinning a Note: Click on the pin icon to pin a note.
- Searching Notes: Use the search bar at the top to find notes.
- Sorting Notes: Use tags to sort and filter notes.
- Toggle Light/Dark Mode: Use the switch in the header to toggle between light and dark modes.
Contributions are welcome! Please fork this repository and submit a pull request with your changes.
- Fork the repository
- Create your feature branch (
git checkout -b feature/YourFeature
) - Commit your changes (
git commit -m 'Add some feature'
) - Push to the branch (
git push origin feature/YourFeature
) - Open a pull request