Notes App is a full-stack MERN (MongoDB, Express, React, Node.js) application designed to help users manage their notes efficiently. It provides a user-friendly interface to create, read, update, and delete notes, with a robust backend handling data storage and retrieval.
- Features
- Screenshots
- Getting Started
- Prerequisites
- Installation
- Usage
- Available Scripts
- Project Structure
- Contributing
- License
- User Authentication: Secure sign-up and login functionality.
- Search Notes: Search notes functionality.
- CRUD Operations: Create, read, update, and delete notes.
- Material Design: Modern UI built with CSS.
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
Make sure you have the following installed on your machine:
- Node.js Runtime
- MongoDB (Database)
-
Clone the repository:
git clone https://github.com/imegeek/notes-app-react cd notes-app-react
-
Install dependencies:
npm install
-
Start the development server:
npm start
This will run both the client and server concurrently. The client will be available at
http://localhost:3000
and the server athttp://localhost:5000
.
In the project directory, you can run:
npm start
: Runs the client and server concurrently.npm run client
: Runs the client app in development mode.npm run server
: Runs the server using nodemon.
Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or new features to add.
This project is licensed under the MIT License. See the LICENSE file for details.