GetMyNotes is a web application that allows users to create, organize, and manage their personal notes in a convenient and efficient way.
- User Registration: Users can create an account to access the application.
- Note Creation: Users can create new notes, providing a title and content.
- Note Organization: Users can organize their notes into different categories or tags for easy retrieval.
- Note Editing: Users can edit existing notes, modifying the title or content.
- Note Deletion: Users can delete unwanted notes.
- Search Functionality: Users can search for specific notes using keywords.
- Responsive Design: The application is designed to work well on different screen sizes and devices.
To run GetMyNotes locally, follow these steps:
-
Clone the repository:
git clone https://github.com/geekyasif/getmynotes.git
-
Navigate to the project directory:
cd getmynotes -
Install the required dependencies:
npm install
-
Set up the environment variables:
-
Create a .env file in the project root.
-
Copy the content of .env.example file into .env.
-
Update the necessary values in the .env file, such as database connection details.
-
Start the application:
npm start
-
Access the application in your browser at http://localhost:3000.
- UsageCreate an account by clicking on the "Sign Up" button.
- Log in with your credentials on the login page.
- Once logged in, you will be directed to the home page where you can start creating your notes.
- Click on the "New Note" button to create a new note.
- Fill in the title and content of the note and click "Save" to add it to your collection.
- To edit an existing note, click on the note title, make the necessary changes, and click "Save" to update it.
- To delete a note, click on the "Delete" button next to the note.
- You can organize your notes by adding relevant tags or categories to them.
- Use the search bar to search for specific notes using keywords.
Contributing Contributions to GetMyNotes are welcome! If you have any bug fixes, feature implementations, or suggestions, please submit a pull request. For major changes, please open an issue first to discuss the proposed changes.
This project is licensed under the MIT License.
```shell
You can now copy and paste the above Markdown code into your README.md file on GitHub.
