Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edricchan03/studybuddy-android
A study buddy with features such as tasks, resources and more!
https://github.com/edricchan03/studybuddy-android
android kotlin material-design study-buddy studybuddy
Last synced: 3 months ago
JSON representation
A study buddy with features such as tasks, resources and more!
- Host: GitHub
- URL: https://github.com/edricchan03/studybuddy-android
- Owner: EdricChan03
- License: mit
- Created: 2017-08-14T11:34:57.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T16:44:52.000Z (3 months ago)
- Last Synced: 2024-11-21T17:39:36.520Z (3 months ago)
- Topics: android, kotlin, material-design, study-buddy, studybuddy
- Language: Kotlin
- Homepage: https://studybuddy.page.link/home
- Size: 13.5 MB
- Stars: 16
- Watchers: 2
- Forks: 9
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/EdricChan03/studybuddy-android/actions/workflows/app-build.yml)
[](https://www.codefactor.io/repository/github/edricchan03/studybuddy-android)
[](https://github.com/EdricChan03/StudyBuddy-android/blob/main/LICENSE)
[](https://github.com/EdricChan03/StudyBuddy-android/releases/latest)
## About the app
The purpose of this app is to help teens, especially students, with their studies.
It contains features that most of the other related apps include but are created from the
perspective of a teenager.
The app was created in 2017 and has since been worked on.
## Software used
This app uses the following software:
Software | Description | Links
---|---|---
Firebase (Analytics, Authentication, Crashlytics, Cloud Messaging, Firestore) | Firebase is mainly used for the authentication and database backend, as well as cloud notifications and logs events when the app unexpectedly crashes. | [Firebase](https://firebase.google.com/)
## Libraries used
For more info about the list of libraries used, check out the `build.gradle.kts`
files ([root `build.gradle.kts`](build.gradle.kts), [app `build.gradle.kts`](app/build.gradle.kts))
and
the [Version Catalog](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml)
file ([`gradle/libs.versions.toml`](gradle/libs.versions.toml).
---
## Downloads
Download the latest
build [here](https://github.com/EdricChan03/StudyBuddy-builds/blob/master/release/com.edricchan.studybuddy-v1.0.0-rc.503.apk)
.
Older versions can be
accessed [here](https://github.com/EdricChan03/StudyBuddy-builds/blob/master/release).
The changelog for each version can also be viewed in [CHANGELOG.md](/CHANGELOG.md).
## Screenshots
_COMING SOON! (Screenshots will be moved to a separate file)_
## Building the source code
If you would like to build the source code, follow these steps:
1. Clone the project locally by either clicking the `Clone or download` > `Download ZIP` or by
running the following commands:
```bash
cd path/to/your/desired-location
git clone https://github.com/EdricChan03/StudyBuddy-android.git
```
2. Run the following in your terminal:
macOS/Linux:
```bash
./gradlew assembleDebug
```
Windows:
```shell
gradlew.bat assembleDebug
```
3. The APK should be signed with the debug key and will be available at `app/build/outputs/apk`.
See [Build a debug APK](https://developer.android.com/studio/build/building-cmdline.html#DebugMode)
for more info.
## Contributing
_COMING SOON (There'll soon be a contributing guide - stay tuned!)_
## Contributors
I would like to thank the following people for their contributions to this project:
Contributor | Reason
---|---
@Yasujizr | Creating logo/notification icons