This is a Notes application built using React, Redux, Tailwind CSS, and a Node-Express API with MongoDB.
This Notes application allows users to create, read, update, and delete notes. It provides a simple and intuitive interface for managing personal or professional notes efficiently. The application uses React for the frontend, Redux for state management, Tailwind CSS for styling, and a Node-Express API with MongoDB for backend functionality.
- Create new notes with titles and descriptions
- View a list of all created notes
- Update existing notes
- Delete unwanted notes
- Responsive design for mobile and desktop devices
To run the application locally, follow these steps:
-
Clone the repository:
git clone https://github.com/TitanEkanayake/Notes-App.git
-
Navigate to the project directory:
cd Notes-App -
Set up environment variables:
Create a .env file in the root directory and add the following variables:
VITE_ENDPOINTURL= Enter the URL for the API. -
Install dependencies:
npm install
-
Start the development server:
npm run dev
-
Access the application in your web browser at
http://localhost:5173/.
Once the application is running, you can perform the following actions:
- First you have to signup and login to the application.If you don't remeber the password there is a forget password option.
- Create a new note by filling out the title and description fields and pressing add note.
- You can see created notes on the home screen.
- There is edit, or delete button on every note.
- Edit a note by clicking the "Edit" button and making changes to the title or description.
- Delete a note by clicking the "Delete" button.
Contributions are welcome! If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or fix:
git checkout -b feature-name. - Make your changes and commit them:
git commit -m 'Add new feature'. - Push to the branch:
git push origin feature-name. - Submit a pull request.
This project is licensed under the MIT License.