Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.06 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.06 KB

Note~Magic

Note-Magic is a full-featured web application built with the MERN stack (MongoDB, Express.js, React, Node.js) that provides users with a secure platform to create, manage, and store notes on the cloud. The application includes robust authentication mechanisms developed from scratch to ensure user data privacy and security.

Features

  • User Authentication: Secure sign-up and login processes with password encryption.
  • Create, Read, Update, Delete (CRUD) Notes: Users can perform all CRUD operations on their notes.
  • Responsive Design: The application is fully responsive and works on all device sizes.
  • Cloud Storage: Notes are stored in a cloud database, allowing users to access their notes from anywhere.
  • User-friendly Interface: Simple and intuitive user interface for easy navigation and note management.

Tech Stack

  • Frontend: React.js
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Authentication: Custom-built authentication system using bcrypt and JWT

Getting Started

Prerequisites

  • Node.js and npm installed on your machine
  • MongoDB database setup

Installation

  1. Clone the repository:

    git clone https://github.com/harshitHash2/note-magic.git
    cd note-magic
    

Running the Application

  1. Start the backend server:

    nodemon index.js
    
  2. Start the frontend development server:

    npm start
    
  3. Open your browser and navigate to http://localhost:3000

Usage

  • Sign up for a new account or log in with your existing credentials.
  • Create new notes, edit or delete existing ones.
  • Access your notes from any device with an internet connection.

Contributing

Contributions are welcome! Please follow these steps:

  • Fork the repository.
  • Create a new branch (git checkout -b feature/your-feature-name)
  • Commit your changes (git commit -m 'Add some feature')
  • Push to the branch (git push origin feature/your-feature-name)
  • Open a pull request

Contact

For any questions or suggestions, please reach out to me at harshit.chauhan2015@gmail.com.