Built with the tools and technologies:
- π Overview
- πΎ Features
- π Repository Structure
- 𧩠Modules
- π Getting Started
- π Project Roadmap
- π€ Contributing
- π License
- π Acknowledgments
β― REPLACE-ME
β― REPLACE-ME
βββ budget_buddy_/
βββ analysis_options.yaml
βββ android
β βββ .gitignore
β βββ app
β βββ build.gradle
β βββ gradle
β βββ gradle.properties
β βββ settings.gradle
βββ assets
β βββ font
β βββ img
βββ lib
β βββ common
β βββ common_widget
β βββ local_notification.dart
β βββ main.dart
β βββ views
βββ pubspec.lock
βββ pubspec.yaml
βββ test
βββ widget_test.dart
.
File | Summary |
---|---|
pubspec.yaml | β― REPLACE-ME |
analysis_options.yaml | β― REPLACE-ME |
pubspec.lock | β― REPLACE-ME |
android
File | Summary |
---|---|
settings.gradle | β― REPLACE-ME |
build.gradle | β― REPLACE-ME |
android.app
File | Summary |
---|---|
build.gradle | β― REPLACE-ME |
android.app.src.main.kotlin.com.example.budgetbuddy
File | Summary |
---|---|
MainActivity.kt | β― REPLACE-ME |
test
File | Summary |
---|---|
widget_test.dart | β― REPLACE-ME |
lib
File | Summary |
---|---|
local_notification.dart | β― REPLACE-ME |
main.dart | β― REPLACE-ME |
lib.common_widget
File | Summary |
---|---|
subscription_cell.dart | β― REPLACE-ME |
image_button.dart | β― REPLACE-ME |
custom_arc_painter.dart | β― REPLACE-ME |
subscription_home_row.dart | β― REPLACE-ME |
custom_arc_180_painter.dart | β― REPLACE-ME |
segment_button.dart | β― REPLACE-ME |
login_buttons.dart | β― REPLACE-ME |
icon_item_row.dart | β― REPLACE-ME |
status_button.dart | β― REPLACE-ME |
stack_row.dart | β― REPLACE-ME |
secondary_button.dart | β― REPLACE-ME |
budgets_row.dart | β― REPLACE-ME |
item_row.dart | β― REPLACE-ME |
round_textfield.dart | β― REPLACE-ME |
primary_button.dart | β― REPLACE-ME |
upcoming_bill_row.dart | β― REPLACE-ME |
lib.common
File | Summary |
---|---|
color_extension.dart | β― REPLACE-ME |
lib.views.calender
File | Summary |
---|---|
calender_view.dart | β― REPLACE-ME |
lib.views.key_features
File | Summary |
---|---|
key_features.dart | β― REPLACE-ME |
lib.views.home
File | Summary |
---|---|
home_view.dart | β― REPLACE-ME |
lib.views.subscription_info
File | Summary |
---|---|
subscription_info_view.dart | β― REPLACE-ME |
lib.views.main_tab
File | Summary |
---|---|
main_tab_view.dart | β― REPLACE-ME |
lib.views.main_tabview
File | Summary |
---|---|
main_tab_view.dart | β― REPLACE-ME |
lib.views.stacks
File | Summary |
---|---|
stacks_used_view.dart | β― REPLACE-ME |
lib.views.settings
File | Summary |
---|---|
settings_view.dart | β― REPLACE-ME |
lib.views.add_subscription
File | Summary |
---|---|
add_subscription_view.dart | β― REPLACE-ME |
lib.views.about
File | Summary |
---|---|
about_view.dart | β― REPLACE-ME |
lib.views.login
File | Summary |
---|---|
welcome.dart | β― REPLACE-ME |
config.dart | β― REPLACE-ME |
sign_in_view.dart | β― REPLACE-ME |
social_config.dart | β― REPLACE-ME |
email_signin.dart | β― REPLACE-ME |
signin.dart | β― REPLACE-ME |
social_login.dart | β― REPLACE-ME |
sign_up_view.dart | β― REPLACE-ME |
social_signin.dart | β― REPLACE-ME |
lib.views.app_guide
File | Summary |
---|---|
app_guide_view.dart | β― REPLACE-ME |
lib.views.spending_budgets
File | Summary |
---|---|
spending_budgets_view.dart | β― REPLACE-ME |
lib.views.card
File | Summary |
---|---|
cards_view.dart | β― REPLACE-ME |
add_cards_view.dart | β― REPLACE-ME |
Dart: version x.y.z
Build the project from source:
- Clone the budget_buddy_ repository:
β― git clone https://github.com/adiyadav123/budget_buddy_
- Navigate to the project directory:
β― cd budget_buddy_
- Install the required dependencies:
β― pub get
To run the project, execute the following command:
β― dart main.dart
Execute the test suite using the following command:
β― dart test
-
Task 1
:Implement feature one. -
Task 2
: Implement feature two. -
Task 3
: Implement feature three.
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: Submit bugs found or log feature requests for the
budget_buddy_
project. - Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/adiyadav123/budget_buddy_
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.'
- Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.
- List any resources, contributors, inspiration, etc. here.