-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 71d0af2
Showing
242 changed files
with
13,636 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Miscellaneous | ||
| *.class | ||
| *.log | ||
| *.pyc | ||
| *.swp | ||
| .DS_Store | ||
| .atom/ | ||
| .buildlog/ | ||
| .history | ||
| .svn/ | ||
|
|
||
| # IntelliJ related | ||
| *.iml | ||
| *.ipr | ||
| *.iws | ||
| .idea/ | ||
|
|
||
| # The .vscode folder contains launch configuration and tasks you configure in | ||
| # VS Code which you may wish to be included in version control, so this line | ||
| # is commented out by default. | ||
| #.vscode/ | ||
|
|
||
| # Flutter/Dart/Pub related | ||
| **/doc/api/ | ||
| **/ios/Flutter/.last_build_id | ||
| .dart_tool/ | ||
| .flutter-plugins | ||
| .flutter-plugins-dependencies | ||
| .packages | ||
| .pub-cache/ | ||
| .pub/ | ||
| /build/ | ||
| /.vscode/ | ||
| /android/app/google-services.json | ||
| /lib/enums/confidential.dart | ||
|
|
||
| # Web related | ||
| lib/generated_plugin_registrant.dart | ||
|
|
||
| # Symbolication related | ||
| app.*.symbols | ||
|
|
||
| # Obfuscation related | ||
| app.*.map.json | ||
|
|
||
| # Exceptions to above rules. | ||
| !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # This file tracks properties of this Flutter project. | ||
| # Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
| # | ||
| # This file should be version controlled and should not be manually edited. | ||
|
|
||
| version: | ||
| revision: c68758fab137f751d56faa1ced119b7a3561e37e | ||
| channel: master | ||
|
|
||
| project_type: app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Contributing Guide | ||
|
|
||
| OU Notes app is Open Source! I love it when people contribute! | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Make sure you have a [GitHub Account](https://github.com/signup/free). | ||
| - Make sure the [Dart SDK](https://www.dartlang.org/tools/sdk/) is installed on your system. | ||
| - Make sure you have [Git](http://git-scm.com/) installed on your system. | ||
| - [Fork](https://help.github.com/articles/fork-a-repo) the [repository](https://github.com/SpinlockLabs/github.dart) on GitHub. | ||
|
|
||
| ## Making Changes | ||
|
|
||
| - [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository) for your changes. | ||
| - [Commit your code](http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository) for each logical change (see [tips for creating better commit messages](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)). | ||
| - [Push your change](https://help.github.com/articles/pushing-to-a-remote) to your fork. | ||
| - [Create a Pull Request](https://help.github.com/articles/creating-a-pull-request) on GitHub for your change. | ||
| - Wait for reviewers to give feedback. | ||
| - When the reviewers think that the Pull Request is ready, they will merge it. | ||
|
|
||
| ## Code Style | ||
|
|
||
| OU Notes follows the famous **Stacked Architecture** [Click Here To Learn It](https://www.youtube.com/playlist?list=PLdTodMosi-BwM4XkagNwe4KADOMWQS5X-). Please note that if your code is not formatted according to the guide as much as possible, we will reject your Pull Request until it is fixed. Some things such as long lines will generally be accepted, however try to make it smaller if possible. | ||
|
|
||
| ## Efficiency | ||
|
|
||
| OU Notes is committed to efficiency as much as possible. If your code is not efficient, then we will probably reject your Pull Request. | ||
|
|
||
| ## Rejections | ||
|
|
||
| Pull Request rejections are not a bad thing. It just means you need to fix something. Perhaps it is important to define 'rejection' as it is used in this case. A rejection is when a OU Notes committer comments on a Pull Request with a comment like 'rejected due to incorrect formatting'. | ||
|
|
||
| ## Contacting Us | ||
|
|
||
| - Email: `[email protected]` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| ## <img src="https://github.com/AbdulMalikDev/OU-Notes-Stacked-Architecture/blob/master/assets/images/Applogo.jpg?raw=true" width="48">OU Notes [Osmania University (O.U)] [](https://github.com/login?return_to=%2FTheAlphamerc%flutter_twitter_clone)  | ||
|      [](https://github.com/Thealphamerc/flutter_twitter_clone) | ||
|
|
||
|
|
||
| **For the Students , By the Students.** <br/> | ||
| An Application for Osmania University students to access educational material at one place built with the famous **Stacked Architecture** in Flutter. | ||
|
|
||
|
|
||
| ## Download App | ||
| <a href="https://play.google.com/store/apps/details?id=com.notes.ounotes"><img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" width="200"></img></a> | ||
|
|
||
| ## Content | ||
| 👉 O.U Notes<br/> | ||
| 👉 O.U Previous Question Papers<br/> | ||
| 👉 O.U Syllabus<br/> | ||
| 👉 O.U Resources<br/> | ||
|
|
||
| ## Features | ||
| 👉 Access documents directly within app using inbuilt PDF viewer<br/> | ||
| 👉 Ability to save documents in downloads<br/> | ||
| 👉 Report documents for admins to review<br/> | ||
| 👉 Notifications about events and other information related to the university<br/> | ||
|
|
||
| :boom: Now any user can upload documents ! :boom: | ||
| * Please read the guidelines and contribution guide for beginners. | ||
|
|
||
|
|
||
|
|
||
| ## Dependencies | ||
| <details> | ||
| <summary> Click to expand </summary> | ||
| * [intl](https://pub.dev/packages/intl) | ||
| * [cuid](https://pub.dev/packages/cuid) | ||
| * [stacked](https://pub.dev/packages/stacked) | ||
| * [share](https://pub.dev/packages/share) | ||
| * [stacked_services](https://pub.dev/packages/stacked_services) | ||
| * [url_launcher](https://pub.dev/packages/url_launcher) | ||
| * [google_fonts](https://pub.dev/packages/google_fonts) | ||
| * [file_picker](https://pub.dev/packages/file_picker) | ||
| * [firebase_auth](https://pub.dev/packages/firebase_auth) | ||
| * [google_sign_in](https://pub.dev/packages/google_sign_in) | ||
| * [firebase_analytics](https://pub.dev/packages/firebase_analytics) | ||
| * [firebase_database](https://pub.dev/packages/firebase_database) | ||
| * [shared_preferences](https://pub.dev/packages/shared_preferences) | ||
| * [path_provider](https://pub.dev/packages/path_provider) | ||
|
|
||
| </details> | ||
|
|
||
| ## Screenshots | ||
|
|
||
| Intro Screen | Home Screen |Home Screen - Dark Mode | Subjects Dialog | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
| Drawer | About us Screen |Profile Screen | Upload Link(resources) Screen | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
| Upload Notes Screen | Upload Question Papers Screen |Upload Syllabus Screen | Upload Choose Screen | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
|
|
||
| Downloaded Notes Screen | Downloaded Question Papers Screen |Downloaded Syllabus Screen | Notes Screen | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
| Question Papers Screen | Syllabus Screen |Links/Resources Screen | All Notes Search Screen | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
|
|
||
| All Question Papers Search Screen | All Syllabus Search Screen |All Resources/Links Search Screen | Search All Subjects Screen | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
|
|
||
| Notes Search Result | Question Paper Search Result |Syllabus Search Result | Resources/Links Search Resultn | ||
| :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------: | ||
|  | ||  | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Getting started | ||
| * Project setup instructions are given at [Wiki](https://github.com/TheAlphamerc/flutter_twitter_clone/wiki/Gettings-Started) section. | ||
|
|
||
| ## Directory Structure | ||
| <details> | ||
| <summary> Click to expand [Stacked Architecture ] </summary> | ||
|
|
||
| ``` | ||
| |-- lib | ||
| | |-- AppTheme | ||
| | | |-- AppStateNotifier.dart | ||
| | | '-- AppTheme.dart | ||
| | |-- CustomIcons | ||
| | | '-- custom_icons.dart | ||
| | |-- app | ||
| | | |-- locator.dart | ||
| | | |-- locator.iconfig.dart | ||
| | | |-- logger.dart | ||
| | | |-- router.dart | ||
| | | '-- router.gr.dart | ||
| | |-- enums | ||
| | | |-- constants.dart | ||
| | | '-- enums.dart | ||
| | |-- main.dart | ||
| | |-- models | ||
| | | |-- course_info.dart | ||
| | | |-- document.dart | ||
| | | |-- download.dart | ||
| | | |-- syllabus.dart | ||
| | | |-- user.dart | ||
| | | '-- vote.dart | ||
| | |-- services | ||
| | | |-- funtional_services | ||
| | | | |-- authentication_service.dart | ||
| | | | |-- cloud_storage_service.dart | ||
| | | | |-- db_service.dart | ||
| | | | |-- email_service.dart | ||
| | | | |-- firestore_service.dart | ||
| | | | |-- sharedpref_service.dart | ||
| | | | '-- third_party_services_module.dart | ||
| | | '-- state_services | ||
| | | |-- download_service.dart | ||
| | | |-- links_service.dart | ||
| | | |-- notes_service.dart | ||
| | | |-- question_paper_service.dart | ||
| | | |-- report_service.dart | ||
| | | |-- subjects_service.dart | ||
| | | |-- syllabus_service.dart | ||
| | | '-- vote_service.dart | ||
| | |-- ui | ||
| | | |-- shared | ||
| | | | |-- app_config.dart | ||
| | | | |-- shared_styles.dart | ||
| | | | '-- ui_helper.dart | ||
| | | |-- views | ||
| | | | |-- FilterDocuments | ||
| | | | | |-- FD_DocumentDisplay | ||
| | | | | | |-- fd_documentview.dart | ||
| | | | | | '-- fd_documentviewmodel.dart | ||
| | | | | |-- FD_InputScreen | ||
| | | | | | |-- fd_inputView.dart | ||
| | | | | | '-- fd_inputViewmodel.dart | ||
| | | | | '-- FD_subjectdisplay | ||
| | | | | |-- fd_subjectview.dart | ||
| | | | | '-- fd_subjectviewmodel.dart | ||
| | | | |-- Profile | ||
| | | | | |-- profile_view.dart | ||
| | | | | '-- profile_viewmodel.dart | ||
| | | | |-- about_us | ||
| | | | | '-- about_us_view.dart | ||
| | | | | (8 more...) | ||
| | | | |-- search | ||
| | | | | |-- search_view.dart | ||
| | | | | |-- search_viewmodel.dart | ||
| | | | | '-- suggestion_list | ||
| | | | | '-- suggestion_list_view.dart | ||
| | | | |-- splash | ||
| | | | | |-- spash_view.dart | ||
| | | | | '-- splash_viewmodel.dart | ||
| | | | '-- syllabus | ||
| | | | |-- syllabus_view.dart | ||
| | | | '-- syllabus_viewmodel.dart | ||
| | | '-- widgets | ||
| | | |-- dumb_widgets | ||
| | | | |-- SaveButtonView.dart | ||
| | | | |-- TextFieldView.dart | ||
| | | | |-- drawer_header.dart | ||
| | | | |-- expantion_list.dart | ||
| | | | |-- nav_item.dart | ||
| | | | |-- no_subjects_overlay.dart | ||
| | | | '-- progress.dart | ||
| | | '-- smart_widgets | ||
| | | |-- FilterSubjects_view | ||
| | | | |-- filtersubjects_view.dart | ||
| | | | '-- filtersubjects_viewmodel.dart | ||
| | | |-- drawer | ||
| | | | |-- drawer_view.dart | ||
| | | | '-- drawer_viewmodel.dart | ||
| | | |-- links_tile_view | ||
| | | | |-- links_tile_view.dart | ||
| | | | '-- links_tile_viewmodel.dart | ||
| | | |-- notes_tile | ||
| | | | |-- notes_tile_view.dart | ||
| | | | '-- notes_tile_viewmodel.dart | ||
| | | |-- question_paper_tile | ||
| | | | |-- question_paper_tile_view.dart | ||
| | | | '-- question_paper_tile_viewmodel.dart | ||
| | | |-- subjects_dialog | ||
| | | | |-- subjects_dialog_view.dart | ||
| | | | '-- subjects_dialog_viewmodel.dart | ||
| | | |-- syllabus_tile.dart | ||
| | | | |-- syllabus_tile_view.dart | ||
| | | | '-- syllabus_tile_viewmodel.dart | ||
| | | '-- user_subject_list | ||
| | | |-- user_subject_list_view.dart | ||
| | | '-- user_subject_list_viewmodel.dart | ||
| | '-- utils | ||
| | '-- file_picker_service.dart | ||
| |-- pubspec.yaml | ||
| ``` | ||
|
|
||
| </details> | ||
| ## Contributing | ||
|
|
||
| If you wish to contribute a change to any of the existing feature or add new in this repo, | ||
| please review our [contribution guide](https://github.com/AbdulMalikDev/OU-Notes-Stacked-Architecture/blob/master/CONTRIBUTING.md), | ||
| and send a [pull request](https://github.com/AbdulMalikDev/OU-Notes-Stacked-Architecture/pulls). I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. | ||
|
|
||
| ## Created & Maintained By | ||
|
|
||
| [Abdul Malik](https://github.com/AbdulMalikDev) And [Syed Wajid](https://github.com/syedwajid01) | ||
|
|
||
| > If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of :coffee: | ||
| > | ||
| > * [PayPal](https://paypal.me/shubhamsinghchahar/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| gradle-wrapper.jar | ||
| /.gradle | ||
| /captures/ | ||
| /gradlew | ||
| /gradlew.bat | ||
| /local.properties | ||
| GeneratedPluginRegistrant.java | ||
|
|
||
| # Remember to never publicly share your keystore. | ||
| # See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app | ||
| key.properties |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>android</name> | ||
| <comment>Project android created by Buildship.</comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| <buildCommand> | ||
| <name>org.eclipse.buildship.core.gradleprojectbuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| </buildSpec> | ||
| <natures> | ||
| <nature>org.eclipse.buildship.core.gradleprojectnature</nature> | ||
| </natures> | ||
| </projectDescription> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| arguments= | ||
| auto.sync=false | ||
| build.scans.enabled=false | ||
| connection.gradle.distribution=GRADLE_DISTRIBUTION(WRAPPER) | ||
| connection.project.dir= | ||
| eclipse.preferences.version=1 | ||
| gradle.user.home= | ||
| java.home=C\:/Program Files/Java/jdk-10.0.2 | ||
| jvm.arguments= | ||
| offline.mode=false | ||
| override.workspace.settings=true | ||
| show.console.view=true | ||
| show.executions.view=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <classpath> | ||
| <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-10/"/> | ||
| <classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/> | ||
| <classpathentry kind="output" path="bin/default"/> | ||
| </classpath> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>app</name> | ||
| <comment>Project app created by Buildship.</comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| <buildCommand> | ||
| <name>org.eclipse.jdt.core.javabuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.buildship.core.gradleprojectbuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| </buildSpec> | ||
| <natures> | ||
| <nature>org.eclipse.jdt.core.javanature</nature> | ||
| <nature>org.eclipse.buildship.core.gradleprojectnature</nature> | ||
| </natures> | ||
| </projectDescription> |
Oops, something went wrong.