Notes Keeper - MERN Stack App

Notes Keeper is a simple web application built with React and Vite for keeping track of your notes.

Features

• userSignLogin : User easily resgiter and login to their portal
• Create Notes: Easily create new notes with a title and content.
• Edit Notes: Edit existing notes with updated information.
• Delete Notes: Remove unwanted notes from your collection.
• Responsive Design: The application is designed to work seamlessly on both desktop and mobile devices.

Technologies Used

Frontend

• React: A JavaScript library for building user interfaces.
• Vite: A fast development server and build tool for modern web development.
• TaiwindCSS: TailwindCSS classes for creating a sleek and modern design.
• MUI: MUI styled Modals for enhanced user interface. (material + JoyUI)

backend

• Expressjs : Fast, unopinionated, minimalist web framework for Node.js.
• mongoose : MongoDB object modeling tool designed to work in an asynchronous environment.
• jwt_auth : JSON Web Token authentication middleware.
• bcryptjs: Library to help hash passwords.
• cookies : Library for handling HTTP cookies.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/notes-keeper.git

Installation

Client (React + Vite)

Navigate to the client directory

cd client

Install dependencies

npm install

Start the development server

npm run dev

Server (Expressjs + mongoose)

# Navigate to the server directory
cd server

Install dependencies

npm install

# Start the server
nodemon /app.js

Usage

As a programmer, Notes Keeper serves as a convenient tool to manage your daily tasks and notes efficiently. Here's how you can leverage its features to stay organized:

1. Note Creation: Use the "New Note" button to quickly jot down ideas, tasks, or reminders. Provide a descriptive title and detailed content for each note to capture important information.

2. Editing Capability: Easily modify existing notes by clicking on them from the list. Edit mode allows you to update titles, content, or any other details as needed. Save your changes with a simple click.

3. Efficient Deletion: Remove outdated or completed tasks by selecting the delete button next to the respective note. This streamlined process ensures your notes stay relevant and clutter-free.

By integrating Notes Keeper into your workflow, you can maintain a structured approach to task management and stay focused on your programming projects. Utilize its intuitive features to track project milestones, brainstorm ideas, and document important insights effectively.

Contributing

If you'd like to contribute to this project, please follow these guidelines.

1. Fork the project.
2. Create your feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

Authors

• Muhammad Ali Aamir - Description of their contribution.