The ** Notes App** is a simple Android application that allows users to create, edit, and delete notes. It provides a user-friendly interface for managing notes, along with basic features such as adding, editing, and deleting notes.
- Create new notes with titles and content.
- Edit existing notes' content.
- Delete unwanted notes.
- Intuitive user interface for managing notes.
- Support for keyboard display with dynamic UI adjustments.
- Android Studio (latest version)
- Android SDK
-
Open Git Bash or your preferred terminal.
-
Clone the repository:
git clone https://github.com/your-username/StickyNotesApp.git
-
Open the project in Android Studio.
- Build and run the app using the Android Studio emulator or a physical device.
- Launch the app to view the list of existing notes.
- To create a new note:
- Tap the Edit button.
- Enter the note's content in the text field.
- Tap the Add button to save the note.
- To edit an existing note:
- Tap the Edit button.
- Tap on the note you wish to edit.
- Modify the content in the text field.
- Tap the Add button to save the changes.
- To delete a note:
- Tap the Delete button next to the note you want to remove.
Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request.
-
Fork the project.
-
Create a new branch.
-
Make your changes and commit them.
-
Push the changes to your fork.
-
Submit a pull request with a description of your changes.
- Introduction
- Getting Started
- App Architecture
- Data Handling
- User Interface
- Composable Functions
- Preview
This documentation provides an in-depth explanation of the implementation details of the Notes app, a simple Android app built using Jetpack Compose. The app allows users to create, edit, and delete notes.
To run the Notes app on your local machine, follow these steps:
- Clone the repository:
https://github.com/Sugardevs-in/Notes/blob/Public_beta1/ - Open the project in Android Studio.
- Build and run the app on an emulator or physical device.
The app follows a basic architecture, consisting of the following main components:
MainActivity: The entry point of the app.Note: A data class representing a note.readNotesFromFile(): Function to read notes from a file.writeNotesToFile(): Function to write notes to a file.removeNoteFromFile(): Function to remove a note from the file.NotesApp: The main composable function for the app UI.NotesCard: Composable function to display individual note cards.
The app uses simple file-based data handling to read and write notes. Notes are stored in a text file named notes.txt. The Note data class is used to represent individual notes.
The user interface is built using Jetpack Compose, providing a modern and declarative way to create UI components. The app consists of the following main UI components:
- A scrollable list of notes displayed using
LazyColumn. - A button to switch between edit mode and view mode.
- An input field for adding notes.
The NotesApp is the main composable function responsible for displaying the app's user interface. It takes a list of saved notes as a parameter and displays them using LazyColumn. The function includes the logic for adding, editing, and deleting notes.
The NotesCard composable function is used to display individual note cards. It takes a Note object and a callback function for deleting notes as parameters. The function creates a card with the note's content and a delete button.
A preview of the app's UI is provided using Jetpack Compose's @Preview annotation. The Show composable function is used to display the app UI with empty notes for preview purposes.
By following this documentation, you can gain a comprehensive understanding of the Notes app's implementation, including its architecture, data handling, user interface, and composable functions.
This project is licensed under the MIT License.