raysummee / swift_travel Goto Github PK

This is an open-source public transport app packed with cool features 😎

If you want to contribute, fork the repository and create a pull-request with your new feature, and make sure to:

• Describe it well
• Include necessary tests
• Follow the coding style

Here is a non-exhaustive list of things that could be improved with their respective subject.

Note: Before trying to contribute, I strongly recommend you try using the app for a few so you get a general understanding of its structure and general functionning.

• Improve widgets, opr application design. To navigate through the app files, the folder structure is similar to the app navigation structure.
  • Example:
    • The widget that displays different routes in the route tab: lib/tabs/routes/route_tile.dart
    • The pages folder is for individual pages or pages not directly related to one of the 3 main tabs.

• Add a new locale:

  • Read ADDING-NEW-LOCALE.md

  Supported locales:

  • 🇬🇧 English
  • 🇫🇷 French
  • 🇩🇪 German
  • 🇮🇹 Italian (Probably innacurate)

• Add your contry's public transport API:

  • Read ADDING-NEW-API.md

  Supported countries:

  • 🇨🇭 Switzerland
  • 🇫🇷 France (40%)

• Improve the live-routing, mainly in the live-route sub-package.

• Implement the skeleton of a homescreen widget on Android.

• Propose or implement a new prediction model to predict new routes bassed on the history. See here.

If you have any question, contact me on Twitter @gaetschwartz 😊