Skip to content

Commit

Permalink
[meta] update to show support of fe; update screenshots; update free …
Browse files Browse the repository at this point in the history
…practice yt search
  • Loading branch information
BrightDV committed Jul 4, 2024
1 parent 23fdcb3 commit 838dd5e
Show file tree
Hide file tree
Showing 18 changed files with 44 additions and 26 deletions.
56 changes: 36 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center"><img src="assets/images/icon.png" width="150"></a></p>
<h2 align="center"><b>Box, Box!</b></h2>
<h4 align="center">Unofficial Android and web app for Formula 1 lovers!</h4>
<h4 align="center">Unofficial Android and Web app for Formula 1 and Formula E fans!</h4>

[![GitHub releases](https://img.shields.io/github/release/BrightDV/BoxBox?style=for-the-badge)](https://github.com/BrightDV/BoxBox/releases/latest)
[![GitHub issues](https://img.shields.io/github/issues/BrightDV/BoxBox?style=for-the-badge)](https://github.com/BrightDV/BoxBox/issues)
Expand All @@ -11,7 +11,6 @@
[![Codeberg mirror](https://img.shields.io/badge/Mirror-Codeberg-blue?style=for-the-badge)](https://codeberg.org/BrightDV/BoxBox)
![https://hosted.weblate.org/engage/box-box/](https://img.shields.io/weblate/progress/box-box?style=for-the-badge)


## Download

[<img src="get-it-on-fdroid.png"
Expand All @@ -31,13 +30,15 @@
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width="235">](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width="235">](fastlane/metadata/android/en-US/images/phoneScreenshots/6.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" width="235">](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" width="235">](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/9.png" width="235">](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)

## Features

- Box, Box! is copylefted libre software, licensed GPLv3+.
- No ads, no trackers or anything else.
- Get the latest stories of your favorite driver and his ranking, even without any Internet connection*. \
If you want, you can know where he is born and other personal info (not very useful though)…
- Get the latest stories of your favorite driver and his ranking, even without any Internet connection\*. \
If you want, you can know where he is born and other personal info (not very useful though)…
- In-app reader for all the editorial articles, with markdown!
- Watch all the latest videos with a dedicated tab and a swipe-up!
- Enjoy the app even at night with dark mode.
Expand All @@ -46,24 +47,33 @@ If you want, you can know where he is born and other personal info (not very use
- Follow all the action on track with integrated WebView (live leaderboard).
- View the results of all the sessions (free practices, qualifying, sprints and races).
- Enjoy the race hub during a GP!
- Follow both Formula 1 and Formula E from the same app!

*You need to have Internet connection in order to refresh the data…
\*You need to have Internet connection in order to refresh the data…

## Instances
| Host | URL |
| -------- | ------- |
| Official | https://brightdv.github.io/boxbox/ |

| Host | URL |
| -------- | ---------------------------------- |
| Official | https://brightdv.github.io/boxbox/ |

## Services used
| Screen | Service | URL |
| :---------------: |:---------------:| :---------------:|
| Home News | Formula 1 API | https://api.formula1.com |
| Home Videos | Formula 1 API | https://api.formula1.com |
| Articles search | SearXNG | [14 instances](lib/api/searx.dart#L26) |
| Standings (Q, S and R) | Ergast API | https://ergast.com/mrd |
| Standings (FP, Q, S and R) | Formula 1 Archives | https://formula1.com |
| Schedule | Ergast API | https://ergast.com/mrd |
| Live Timing | Formula 1 | https://formula1.com |

### Formula 1

| Screen | Service | URL |
| :------------------------: | :----------------: | :------------------------------------: |
| Home News | Formula 1 API | https://api.formula1.com |
| Home Videos | Formula 1 API | https://api.formula1.com |
| Articles search | SearXNG | [14 instances](lib/api/searx.dart#L26) |
| Standings (Q, S and R) | Ergast API | https://ergast.com/mrd |
| Standings (FP, Q, S and R) | Formula 1 Archives | https://formula1.com |
| Schedule | Ergast API | https://ergast.com/mrd |
| Live Timing | Formula 1 | https://formula1.com |

### Formula E

Everything comes from the same API (Formula E API): https://api.formula-e.pulselive.com.

## Translation

Expand All @@ -74,12 +84,14 @@ Help translate _Box, Box!_ on [Hosted Weblate](https://hosted.weblate.org/projec
</a>

Or, manually:

- Create a file named **[your language ISO code, like en, fr, etc].arb**
Theses files are used by Flutter to provide you the translation.
These files are used by Flutter to provide you the translation.
- Translate [this file](lib/l10n/app_en.arb) to your language (only the text between the quotes).
- Finally, make a pull request or an issue and attach the code to it.

The app is currently available in:

- 🇬🇧 English
- 🇫🇷 French
- 🌐 Arabic, thanks to [@Music47ell](https://github.com/Music47ell)
Expand All @@ -98,7 +110,8 @@ The app is currently available in:
and thanks to the other translators!

## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

```
Box, Box! is Free Software: You can use, study, share, and improve it at
Expand All @@ -109,11 +122,14 @@ published by the Free Software Foundation, either version 3 of the License, or
```

## Notes

I'm developing this app in my free time, so I appreciate feedback and welcome PRs!

(_Box, Box!_ is unofficial software and in no way associated with the Formula 1 group of companies.)
(_Box, Box!_ is unofficial software and in no way associated with the Formula 1 group of companies nor the Formula E group of companies.)

Some interesting Formula 1 related projects:

- The amazing [Ergast API](https://ergast.com/mrd).
- [bacinger/f1-circuits](https://github.com/bacinger/f1-circuits): geo points for the map of each circuit.
- [theOehrly/Fast-F1](https://github.com/theOehrly/Fast-F1): client for live telemetry (upcoming) and stats, in Python.
- [slowlydev/f1-dash](https://github.com/slowlydev/f1-dash): feature-rich livetiming webview used by the app.
1 change: 1 addition & 0 deletions fastlane/metadata/android/en-US/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ Features:
- While a Grand Prix is running, follow the schedule of the different sessions and read the related FIA's documents.
- Enjoy the app in the colours of your favorite team!
- Open links in-app.
- Follow both Formula 1 and Formula E from the same app!

Be in the action even without ads or trackers ;)
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fastlane/metadata/android/en-US/images/phoneScreenshots/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion fastlane/metadata/android/en-US/short_description.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Unofficial app for Formula 1 lovers!
Unofficial app for Formula 1 and Formula E fans!
1 change: 1 addition & 0 deletions fastlane/metadata/android/fr/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ Fonctionnalités:
- Pendant un Grand-Prix, suivez les horaires des différentes sessions et lisez les documents de la FIA à propos du Grand-Prix.
- L'application porte les couleurs de votre équipe favorite !
- Ouvrir les liens dans l'application.
- Suivez la Formule 1 et la Formule E depuis la même application !

Soyez dans l'action même sans publicité ni traceur ;)
2 changes: 1 addition & 1 deletion fastlane/metadata/android/fr/short_description.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Application non-officielle pour suivre la Formule 1!
Application non-officielle pour suivre la Formule 1 et la Formule E !
4 changes: 2 additions & 2 deletions lib/Screens/free_practice_screen.dart
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ class FreePracticeResultsList extends StatelessWidget {
var yt = YoutubeExplode();
final List<Video> searchResults = await yt.search.search(
sessionIndex == 10
? "$championship Free Practice $sessionIndex $raceName $raceYear"
: "$championship Qualifyings $sessionIndex $raceName $raceYear",
? "$championship Qualifyings $raceName $raceYear"
: "$championship Free Practice $sessionIndex $raceName $raceYear",
);
final Video bestVideoMatch = searchResults[0];
await launchUrl(
Expand Down
2 changes: 1 addition & 1 deletion lib/l10n/app_en.arb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"about": "About",
"@about": {},
"aboutDescription": "Box, Box! is copylefted libre software, licensed under GPLv3+. Its aim is to allow users to follow Formula 1 without ads or trackers.",
"aboutDescription": "Box, Box! is copylefted libre software, licensed under GPLv3+. Its aim is to allow users to follow Formula 1 and Formula E without ads or trackers.",
"@aboutDescription": {},
"aboutBottomLine": "With ❤ by BrightDV.",
"@aboutBottomLine": {},
Expand Down
2 changes: 1 addition & 1 deletion lib/l10n/app_fr.arb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"about": "À propos",
"@about": {},
"aboutDescription": "Box, Box! est une application libre, sous licence GPLv3+. Elle vise à permettre de suivre la Formule 1 sans pubs ni traceurs.",
"aboutDescription": "Box, Box! est une application libre, sous licence GPLv3+. Elle vise à permettre de suivre la Formule 1 et la Formule E sans pubs ni traceurs.",
"@aboutDescription": {},
"aboutBottomLine": "Fait avec ❤ par BrightDV.",
"@aboutBottomLine": {},
Expand Down

0 comments on commit 838dd5e

Please sign in to comment.