Skip to content

Latest commit

History

2,684 Commits

Folders and files

NameName
Last commit message
Last commit date

Android Design Patterns

Android Design patterns

Nullable labsAndroid patternsAndroid patterns

GitHub tag (latest by date)GitHub Release DateLines of codeGitHub closed issuesGitHub closed pull requestsGitHub repo sizeGitHub last commitGitHubGitHub language countGitHub search hit counterGitHub Repository branchesGitHub Repository dependents

FOSSA StatusRenovatebotDependabotNewReleasesHits-of-CodeComVerGitHub Super-LinterDocumentation Status

🎹 Table of contents

Summary

AndroidProject Status: Active – The project has reached a stable, usable state and is being actively developed.Project created statusProject updated status

Android Design Patterns is intended to provide various use case scenarios and architectural concepts on prototyping adaptive applications.

mkdocs.yml # Configuration file.
docs/
readme.md # General information
summary.md # Table of contents
units/
design-patterns.md # Design patterns and architectural concepts
scenarios.md # Scenarios in practice
use-cases.md # Typical use cases user-guide/
changelog.md # Changelog page code_of_conduct.md # Code of conduct page code_owners.md # Code owners page dependency.md # Dependency page description.md # Description page
faq.md # FAQ page
getting-started.md # Getting started page
troubleshooting.md # Troubleshooting page
upgrade.md # Upgrade page
reporting/
info.md # Informational page
issue_template.md # Issue template page
bug_report.md # Bug report template
custom_report.md # Custom report template
feature_request_template.md # Feature request template
pull_request_template.md # Pull request template
contributing/
info.md # Contributing page
links/
info.md # Links page

📝 Documentation

The Website documentation is provided by gitbook and can be discovered at url:

Android Patterns

To enable documentation serving at localhost you can run the following script

./scripts/build-docs.sh

otherwise, the next steps should be considered:

1) Install/upgrade pip command-line utility:

pip install --upgrade pip

or if you need to install pip for the first time:

wget --no-check-certificate https://bootstrap.pypa.io/get-pip.py
python get-pip.py

2) Install the mkdocs package using pip:

pip install mkdocs

or more conveniently for Windows subsystem:

python -m pip install mkdocs
python -m mkdocs

3) Install the material theme for the website:

python -m pip install mkdocs-material
python -m pip install markdown-include
...
(see requirements.txt)
...

4) Start the server at localhost by running the following command:

python -m mkdocs build --clean --config-file mkdocs.yml
python -m mkdocs serve --verbose --dirtyreload

5) Deploy to GitHub pages:

python -m mkdocs --verbose gh-deploy --force --remote-branch gh-pages

5) Open up localhost in browser to get the default documentation homepage.

🧶 Kubernetes

Running k8s cluster with tilt command by acquiring k8s deployment configuration:

tilt up

Shutting down k8s cluster with provisioned resources removal:

tilt down --delete-namespaces

Statistics

Documentation PageSpeed result dashboard

📝 Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

🌹 Authors

Android Patterns is maintained by the following GitHub team-members:

  • Author

with community support please contact with us if you have some question or proposition.

💕 Contributing

Contributors Display

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).

This project follows the all-contributors specification. Contributions of any kind are welcome!

PRs WelcomeGithub contributors

See also the list of contributors who participated in this project.

🚨 Visitor stats

GitHub page hits

GitHub starsGitHub forksGitHub watchers

Licensing

Android Patterns is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

image

🌟 Development Support

Like Android Design patterns and Android Patterns ? Consider buying me a coffee :)

Become a PatronBuy Me A CoffeeKoFi

👨‍👨‍👧‍👦 Acknowledgement

Stargazers repo roster for @AlexRogalskiy/android-patterns

Stargazers over time

Statistics report

📎 OpenGraph Card

OpenGraph card

🔥 Feeds and Podcasts

Reddit posts

InfoWorld posts

RedHat posts

Android Authority posts

Android Arsenal posts

Medium posts

Gizmodo posts

Mobile Dev Memo posts

Infinum posts


forthebadgeforthebadgeforthebadge

About

🏆 Android4You Design patterns

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages