Skip to content

SNote is a lightweight Android app for creating, editing, searching, and managing notes locally with SQLite or syncing them through cloud storage

License

Notifications You must be signed in to change notification settings

chutrunganh/SNote-IT4785E

Repository files navigation

SNote

This project, developed for the Mobile Programming Course IT4785E (Semester 20241) at HUST, is a simple note-taking application for Android devices. The application enables users to view, search, create, edit, delete, and synchronize notes through cloud storage.

While similar projects are widely available on platforms like GitHub, this repository stands out by including a detailed report and presentation slides, emphasizing the development process and the knowledge gained throughout the course.

For detailed information, please refer to our report

🚀 Features

Better to view this README.md in dark mode

  • View and search notes in the main screen

HomeFragment

  • Add new note
HomeFragment HomeFragment
  • Edit/Delete note
HomeFragment HomeFragment
  • Synchronize notes through cloud storage
HomeFragment HomeFragment

Note

To enable synchronization between devices, both must use the same google-services.json file. Instructions for generating this file are provided in the installation section.

🛠️ Installation

1. Use the apk file

You can simply download the apk file from the [release page](Not availabale yet) to enjoy the application

2. Build from source

  1. Clone the repository:

    git clone https://github.com/chutrunganh/SNote-IT4785E.git
  2. Open the project in Android Studio, or IntelliJ IDEA.

  3. Build the project to download all dependencies.

  4. Connect the project to Firebase by following these steps:

    In Android Studio, click on the Tools menu -> Firebase -> Cloud Storage -> get started with Cloud Storage. Follow the instructions to connect the project to Firebase.

    Connect To Firebase

    It will naviagate you to Firebase Console, create a new project -> Build -> Firestore Database -> Create Database -> Start in test mode. Then after that, our app is connected to Firebase.

  5. Run the application on an emulator or a physical device.

💻 Technologies Used

  • Kotlin: Programming language
  • Room: Local database for storing notes.
  • Firebase Firestore: Cloud storage for synchronizing notes.
  • Android Jetpack Components: Including LiveData, ViewModel, and Navigation.

🤝 Contributing

This project is developed by menbers:

Name Student ID
Chu Trung Anh 20225564
Bui Duy Anh 20225563

📜 License

License: MIT

This project is licensed under the MIT License - see the LICENSE for details.

📧 Contact

This project is maintained by: Chu Trung Anh - Email.

Feel free to contact me if you have any question or suggestion.

About

SNote is a lightweight Android app for creating, editing, searching, and managing notes locally with SQLite or syncing them through cloud storage

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages