https://github.com/chutrunganh/snote-it4785e
SNote is a lightweight Android app for creating, editing, searching, and managing notes locally with SQLite or syncing them through cloud storage
https://github.com/chutrunganh/snote-it4785e
firebase hust it4785 it4785e mobile-programming note-taking-app project room
Last synced: about 1 year ago
JSON representation
SNote is a lightweight Android app for creating, editing, searching, and managing notes locally with SQLite or syncing them through cloud storage
- Host: GitHub
- URL: https://github.com/chutrunganh/snote-it4785e
- Owner: chutrunganh
- License: mit
- Created: 2024-12-19T04:27:36.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-23T12:49:51.000Z (over 1 year ago)
- Last Synced: 2025-03-24T03:34:52.928Z (about 1 year ago)
- Topics: firebase, hust, it4785, it4785e, mobile-programming, note-taking-app, project, room
- Language: Kotlin
- Homepage:
- Size: 15.7 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/chutrunganh/SNote-IT4785E/blob/master/Slide_and_Report/Mobile_Project_Report.pdf)
# 🚀 Features
*Better to view this README.md in dark mode*
- **View and search notes in the main screen**
- **Add new note**
- **Edit/Delete note**
- **Synchronize notes through cloud storage**
> [!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](https://github.com/chutrunganh/SNote-IT4785E/releases/) to enjoy the application
## 2. Build from source
1. Clone the repository:
```sh
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.
It will naviagate you to [Firebase Console](https://console.firebase.google.com), create a new project -> Build -> Firestore Database -> Create Database -> Start in test mode (for quick setup, but our
database will only be accessible in 30 days) / Start in production mode (need to change in Rules tab, from allow read, write: if false; to allow read, write: if true). After
that, you should see the `google-services.json` file in your project (May need to choose view from Android to Project to see the file in IDE).
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
[](https://opensource.org/licenses/MIT)
This project is licensed under the MIT License - see the [LICENSE](https://opensource.org/license/mit) for details.
# 📧 Contact
This project is maintained by: Chu Trung Anh - [Email](mailto:chutrunganh04@gmail.com).
Feel free to contact me if you have any question or suggestion.