MakeNotes

MakeNotes is a note-taking application built using the MERN stack (MongoDB, Express.js, React.js, Node.js) with Tailwind CSS for styling. It allows users to add, update, and delete notes with a simple and minimal design that is easy to use and responsive.

Features

• Add Notes: Users can easily add notes with a title and text content.
• Update Notes: Existing notes can be edited and updated in real-time.
• Delete Notes: Users can delete notes they no longer need.
• Minimal Design: Clean and easy-to-understand interface.
• Responsive Design: Works well on all screen sizes including mobile and desktop.
• Easy Setup: Simple to fork, clone, and run locally.
• Real-time Feedback: Uses react-toastify for user notifications.

Toolstack

• React.js: Frontend library for building user interfaces.
• Tailwind CSS: Utility-first CSS framework for styling.
• MongoDB: NoSQL database for storing notes data.
• Express.js: Backend framework for building RESTful APIs.
• Node.js: JavaScript runtime for server-side programming.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Node.js
• npm (Node Package Manager)
• MongoDB

Installation

1. Fork the repository: Click on the "Fork" button on the top right corner of this repository page.

2. Clone the repository: Clone the forked repository to your local machine.

   git clone https://github.com/YourUsername/MakeNotes.git
   

3. Navigate into the project directory:

   cd MakeNotes
   

4. Install client dependencies:

   cd client
   npm install
   

5. Install server dependencies:

   cd ../server
   npm install
   

6. Start the client:

   cd client
   npm start
   

7. Start the server:

   cd ../server
   npm start
   

Usage

• Add a new note: Click the "Add Note" button to create a new note.
• Edit a note: Click on the note you want to edit, modify the text directly, and save it.
• Delete a note: Click the "Delete" button to remove a note.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project.

2. Create your Feature Branch:

   git checkout -b feature/AmazingFeature

3. Commit your Changes:

   git commit -m 'Add some AmazingFeature'

4. Push to the Branch:

   git push origin feature/AmazingFeature

5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

ngangomnongamba3@egmail.com