Skip to content

README.md

Latest commit

 

History

History
55 lines (44 loc) · 2.65 KB

README.md

File metadata and controls

55 lines (44 loc) · 2.65 KB

Notepad App - README

Lab-notes

Table of Contents

1. Introduction

The Notepad App is a web application that allows users to create, edit, delete, and view notes at any time. Whether you need to jot down addresses, phone numbers, meeting notes, or save your favorite URLs for later reference, this app provides a convenient and organized way to manage your notes efficiently.

In today's fast-paced world, taking notes is a common and essential activity. However, traditional paper notebooks or scattered note-taking methods can lead to lost or forgotten information. The Notepad App aims to solve this problem by offering a user-friendly interface to keep track of your notes, ensuring you never miss an important piece of information again.

2. Features

  • Create new notes with titles and content.
  • Edit existing notes to update their information.
  • Delete unwanted notes.
  • View and manage all notes in one place.
  • Organize notes by the most recent date.
  • User authentication to secure personal notes.

3. Technologies

The Lab-notes App was built using the following technologies:

Frontend:

  • React: A popular JavaScript library for building user interfaces.
  • React Icons: Icon library for React applications.
  • Modal: A library for creating accessible modal dialogs.
  • PropTypes: Runtime type checking for React props.

Backend:

  • Firebase: A cloud-based platform for building web and mobile applications. Getting Started

4. Getting Started

  • To use the LabNotes App click this link
  • Upon launching the app, you will be presented with the Notepad interface.
  • Create a new note by clicking the "New Note" button and filling in the title and content fields.
  • To edit a note, click on the note you wish to modify, make your changes, and save the updated note.
  • To delete a note, click on the delete icon associated with the note.
  • All notes will be displayed with the most recent notes appearing first.

5. Contributing

We welcome contributions to enhance the Notepad App. If you want to contribute, follow these steps:

  • Fork the repository. *Create a new branch: git checkout -b feature/your-feature. *Make your changes and commit them: git commit -m "Add your message here". *Push the changes to your forked repository: git push origin feature/your-feature. *Create a pull request to the main repository.