diff --git a/.github/ISSUE_TEMPLATE/showcase-your-app.md b/.github/ISSUE_TEMPLATE/showcase-your-app.md new file mode 100644 index 0000000000..9c510796b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/showcase-your-app.md @@ -0,0 +1,37 @@ +--- +name: Showcase your app +about: Submit your BeeWare application to be showcased on the website. +title: '' +labels: '' +assignees: '' + +--- + +## App name + + +## App link + + +## App platform(s) +- [ ] macOS +- [ ] Windows +- [ ] Linux +- [ ] Android +- [ ] iOS +- [ ] Web +- [ ] Console + +## App logo (optional) + + +## App screenshot (optional) + + +## App description + + +## App submission checklist + +- [ ] I will abide by the BeeWare Code of Conduct +- [ ] I have read and have followed the **CONTRIBUTING.md** file diff --git a/docs/config.yml b/docs/config.yml index 9fba1f0e63..8ce610187d 100644 --- a/docs/config.yml +++ b/docs/config.yml @@ -7,6 +7,7 @@ nav: - What is BeeWare?: about/overview.md - The Bee Team: about/team.md - History and Philosophy: about/history.md + - Success stories: about/success.md - Contact: about/contact.md - Branding guidelines: about/branding.md - Documentation: diff --git a/docs/en/about/index.md b/docs/en/about/index.md index 5a1a86c396..7c4e546d01 100644 --- a/docs/en/about/index.md +++ b/docs/en/about/index.md @@ -13,6 +13,10 @@ A first-timer's [introduction](overview.md) to the BeeWare project. The [history and philosophy](history.md) of the BeeWare project. +## [Success stories](success.md) + +A [showcase of applications](success.md) built using the BeeWare tool suite. + ## [The Bee Team](team.md) The [core team](team.md) behind BeeWare development. diff --git a/docs/en/about/success.md b/docs/en/about/success.md new file mode 100644 index 0000000000..96feb69c5f --- /dev/null +++ b/docs/en/about/success.md @@ -0,0 +1,133 @@ +# Success stories { #success-stories } + +Want to see examples of the BeeWare tools in use? Here are some. + +
+ +## ![Travel Tips icon](../images/success_stories/travel_tips/travel_tips_logo.webp){ .success-story-icon } [Travel Tips](https://apps.apple.com/au/app/travel-tips/id1336372310) + +
+ +[![Travel Tips iPad screenshot](../images/success_stories/travel_tips/travel_tips_ipad_screenshot.webp)](../images/success_stories/travel_tips/travel_tips_ipad_screenshot.webp){ .success-story-screenshot } + +**Platform:** iOS + +App Store app that uses Toga to define its user interface. + +
+
+ +
+ +## ![Eddington icon](../images/success_stories/eddington/eddington_logo.webp){ .success-story-icon } [Eddington](https://github.com/EddLabs/eddington-gui) + +
+ +Data fitting tool based on Toga and Briefcase. + +
+
+ +
+ +## ![taRpnCalcTG icon](../images/success_stories/taRpnCalcTG/taRpnCalcTG_logo.webp){ .success-story-icon } [taRpnCalcTG](https://www.tanapro.ch/joomla3/index.php/downloads) + +
+ +**Platforms:** Android, Windows, macOS + +Extensible calculator with Python scripting support. + +
+
+ +
+ +## ![pyPlayground icon](../images/success_stories/pyPlayground/pyPlayground_logo.webp){ .success-story-icon } [pyPlayground](https://www.tanapro.ch/joomla3/index.php/downloads) + +
+ +**Platforms:** Android, Windows + +App for experimenting with Toga without setting up the full development tooling. + +
+
+ +
+ +## ![taAppLister icon](../images/success_stories/taAppLister/taAppLister_logo.webp){ .success-story-icon } [taAppLister](https://play.google.com/store/apps/details?id=ch.tanapro.taapplister) + +
+ +**Platform:** Android + +App for listing and exporting installed apps. + +
+
+ +
+ +## [RemoteCommand](https://www.tanapro.ch/joomla3/index.php/downloads) + +
+ +**Platforms:** Windows, macOS + +App for clipboard synchronization between desktop systems. + +
+
+ +
+ +## ![ChariotGazer icon](../images/success_stories/chariotGazer/chariot_gazer_logo.ico){ .success-story-icon } [ChariotGazer](https://insanesharpness.gitlab.io/ChariotGazer/) + +
+ +**Platforms:** Android, Windows + +Provides detailed information about UK registered vehicles. + +
+
+ +
+ +## ![Patent Toolkit icon](../images/success_stories/patent_toolkit/patent_toolkit_logo.webp){ .success-story-icon } [Patent Toolkit](https://patenttk.com) + +
+ +**Platforms:** Windows, macOS + +Suite of productivity tools for patent professionals. + +
+
+ +
+ +## ![Easy Media Server icon](../images/success_stories/easy_media_server/easy_media_server_logo.webp){ .success-story-icon } [Easy Media Server](https://apps.rsmail.co/easy-media-server) + +
+ +**Platform:** macOS + +DLNA media server for streaming content to devices such as Smart TVs. + +
+
+ +
+ +## ![Beanquick icon](../images/success_stories/beanquick/beanquick_logo.webp){ .success-story-icon } [Beanquick](https://twobitsware.com/beanquick) + +
+ +**Platform:** macOS + +Fast desktop app for double-entry bookkeeping. + +
+
diff --git a/docs/en/images/success_stories/beanquick/beanquick_logo.webp b/docs/en/images/success_stories/beanquick/beanquick_logo.webp new file mode 100644 index 0000000000..49ede5d353 Binary files /dev/null and b/docs/en/images/success_stories/beanquick/beanquick_logo.webp differ diff --git a/docs/en/images/success_stories/chariotGazer/chariot_gazer_logo.ico b/docs/en/images/success_stories/chariotGazer/chariot_gazer_logo.ico new file mode 100644 index 0000000000..52e87c8fed Binary files /dev/null and b/docs/en/images/success_stories/chariotGazer/chariot_gazer_logo.ico differ diff --git a/docs/en/images/success_stories/easy_media_server/easy_media_server_logo.webp b/docs/en/images/success_stories/easy_media_server/easy_media_server_logo.webp new file mode 100644 index 0000000000..695146b599 Binary files /dev/null and b/docs/en/images/success_stories/easy_media_server/easy_media_server_logo.webp differ diff --git a/docs/en/images/success_stories/eddington/eddington_logo.webp b/docs/en/images/success_stories/eddington/eddington_logo.webp new file mode 100644 index 0000000000..d0a173148d Binary files /dev/null and b/docs/en/images/success_stories/eddington/eddington_logo.webp differ diff --git a/docs/en/images/success_stories/patent_toolkit/patent_toolkit_logo.webp b/docs/en/images/success_stories/patent_toolkit/patent_toolkit_logo.webp new file mode 100644 index 0000000000..f4a88f9abc Binary files /dev/null and b/docs/en/images/success_stories/patent_toolkit/patent_toolkit_logo.webp differ diff --git a/docs/en/images/success_stories/pyPlayground/pyPlayground_logo.webp b/docs/en/images/success_stories/pyPlayground/pyPlayground_logo.webp new file mode 100644 index 0000000000..729c7bc89c Binary files /dev/null and b/docs/en/images/success_stories/pyPlayground/pyPlayground_logo.webp differ diff --git a/docs/en/images/success_stories/taAppLister/taAppLister_logo.webp b/docs/en/images/success_stories/taAppLister/taAppLister_logo.webp new file mode 100644 index 0000000000..edf5977f59 Binary files /dev/null and b/docs/en/images/success_stories/taAppLister/taAppLister_logo.webp differ diff --git a/docs/en/images/success_stories/taRpnCalcTG/taRpnCalcTG_logo.webp b/docs/en/images/success_stories/taRpnCalcTG/taRpnCalcTG_logo.webp new file mode 100644 index 0000000000..6c8c1ab257 Binary files /dev/null and b/docs/en/images/success_stories/taRpnCalcTG/taRpnCalcTG_logo.webp differ diff --git a/docs/en/images/success_stories/travel_tips/travel_tips_ipad_screenshot.webp b/docs/en/images/success_stories/travel_tips/travel_tips_ipad_screenshot.webp new file mode 100644 index 0000000000..58171a3f52 Binary files /dev/null and b/docs/en/images/success_stories/travel_tips/travel_tips_ipad_screenshot.webp differ diff --git a/docs/en/images/success_stories/travel_tips/travel_tips_logo.webp b/docs/en/images/success_stories/travel_tips/travel_tips_logo.webp new file mode 100644 index 0000000000..71bbc4f36d Binary files /dev/null and b/docs/en/images/success_stories/travel_tips/travel_tips_logo.webp differ diff --git a/docs/en/stylesheets/beeware.css b/docs/en/stylesheets/beeware.css index aa2b544f81..b6a2b6bd45 100644 --- a/docs/en/stylesheets/beeware.css +++ b/docs/en/stylesheets/beeware.css @@ -645,3 +645,29 @@ h1 .news { margin-top: auto; margin-bottom: auto; } + +/* Success stories */ +.success-story-icon { + border-radius: 0.85rem; + width: 30px; + margin-right: 1rem; +} + +.success-story-screenshot img { + width: 5rem; + float: left; + margin-right: 2rem; +} + +.success-story { + margin-bottom: 1.5rem; +} + +.success-story-content { + display: flow-root; +} + +.success-story > h2 { + display: flex; + align-items: center; +} diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index c7b4372c5d..f65328240a 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -25,6 +25,7 @@ bandana Batavia Batavia's BDFN +Beanquick BeeKeeper beeware BeeWare @@ -47,6 +48,7 @@ BZip changelog Chaquopy Chaquopy's +ChariotGazer CMake codebase codebases @@ -80,6 +82,7 @@ Disqus DjangoCon DjangoGirls Djangonaut +DLNA DMG DMGs Dockerfile @@ -220,6 +223,7 @@ PyLadies Pyodide PyOhio PyPI +pyPlayground PyQt PyScript PySide @@ -237,6 +241,7 @@ regex regexes rehint reimplement +RemoteCommand renderer repo reStructuredText @@ -264,6 +269,8 @@ subprocess subprocesses subprojects symlinks +taAppLister +taRpnCalcTG templated testbed timeframe diff --git a/pyproject.toml b/pyproject.toml index fe9c1cd930..6e845888a4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,7 +34,7 @@ translate = [ [tool.rumdl] flavor = "mkdocs" include = ["**/*.md"] -exclude = ["comment.md", "CODE_OF_CONDUCT.md", "docs-redirect/en/README.md"] +exclude = ["comment.md", "CODE_OF_CONDUCT.md", "docs-redirect/en/README.md", ".github/ISSUE_TEMPLATE/showcase-your-app.md"] respect-gitignore = true # Disable rules: