Skip to content

better-rail/app

Repository files navigation

Better Rail

 

Better Rail is an open source mobile client for Israel Railways, with an emphasis on great design, performance and accessibility.

Available on the App Store & Play Store

Overview

Better Rail is written primarily with React Native. We also use Swift & SwiftUI to leverage native iOS functionalities.

Installation

The following steps assumes your environment is already set up for running React Native apps.
If this is your first time, check out the official set up guide beforehand.

Note: Building for iOS requires Xcode 14.2 or above

  • Fork the repo and clone to your machine.
  • Run yarn install
  • MacOS / Linux users: Run yarn rename-dev-configs to rename the firebase development configs.
  • Windows users: Duplicate the firebase configs in /ios and /android/app, and remove the .development suffix from the duplicated files.
  • Run yarn start to start the metro development server
  • Run the app with yarn ios (to open the iPhone simulator) or yarn android (for the Android simulator).

If you want to contribute and face issues during instllation, please reach out to us at feedback@better-rail.co.il and we'll try to help!

License

The source code is released under the AGPL-3.0 license.
The project assets - the user interface, app branding, images, illustations, icons and fonts are outside the scope of the license.