Buddha Quotes Compose

A collaborative project to create a Free and Open Source Buddha Quotes app, written in Jetpack Compose

Report Bug . Request Feature

About The Project

This project is a complete rewrite of Buddha Quotes in Jetpack Compose. We have the intention of adding every feature that was in the original Buddha Quotes into this project, but as shown in the roadmap, not every feature has been added yet. The flexibility of writing in Jetpack Compose has meant that we are able to write quicker and seeing as we are writing this from the ground up, we have added a few new features already, such as a Daily Quote.

Built With

• Jetpack Compose
• Kotlin
• Kotlin Coroutines
• Room Database
• Hilt
• Proto Datastore
• MVVM Architecture

Getting Started

As this project is incomplete and always changing, there are no releases yet. Once we are happy that all core features have been added, we will merge this project with Buddha Quotes. Until then, you can absolutely build this project from source or even contribute, if you so wish.

Prerequisites

To build Buddha Quotes Compose, you will need Android Studio Canary. This will come preinstalled with every tool necessary to build the app, such as JDK 11 and Gradle.

1. Install Android Studio Canary

Installation

1. Clone the repo

git clone https://github.com/BanDev/Buddha-Quotes-Compose.git

2. Build the project

./gradlew build

Roadmap

As this project is written from scratch in Jetpack Compose, not everything has been added from the original Buddha Quotes.

• Show new quote
• Daily quote
• Favouriting a quote
• Meditation timer
• Libraries page
• Viewing lists
• Editing lists
• Adding a quote to a list
• About page
• Widgets (Compose API not yet released but is on roadmap)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Buddha Quotes Compose is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Authors

• Russell Banks - Comp Sci Student - Russell Banks
• Jack Devey - Comp Sci Student - Jack Devey