Bike Index

|

Important

This project is incomplete and under active development. No guarantees are provided.

iOS client for bikeindex.org

Quick Start

To get started:

1. Copy the BikeIndex-template.xcconfig file into BikeIndex-development.xcconfig and BikeIndex-production.xcconfig files.
   • BikeIndex-development is used for the Debug (development) build scheme. This should use your local development instance.
   • BikeIndex-production is used for the Debug (production) build scheme and for archive/release builds. This is only required for releases.
2. Follow the template instructions to provide your own application configuration
   • Sign in to https://bikeindex.org/oauth/applications and create an application
   • or sign in to your local instance and create an API key
   • Add a Callback URL to the application
   • Paste the callback URL, application ID, and secret into the corresponding .xcconfig file
3. If building for a device you will need to provide a bundle identifier and your development team
4. Build and run!

Development

• Requirements: Xcode 16.0
• Target deployment: iOS 17.2

This project uses SwiftUI and SwiftData. At this time iOS (iPhone) is the primary development target with a long-term goal to include iPad and Mac support.

Set up suite of tools

1. Install brew
2. brew install bundle
   • Note: Brew bundle is separate from the Gem bundle
3. brew bundle install
4. rbenv install
5. bundle install

At this point the full suite of tools should be installed and available.

Tests

Test-driven development is an important tool for this project. In your local environment run the tests with Xcode, or set up the local suite of tools to install fastlane and run bundle exec fastlane ios tests.

UI Test configuration

Running UI Tests from Xcode may cache logged-in state. Set up a credentials xcconfig file to ensure UI tests are always able to log-in and proceed (for both Xcode and fastlane invocations).

1. Copy the SharedTests/Test-credentials-template.xcconfig file to SharedTests/Test-credentials.xcconfig.
2. Edit the source to add a test username and password that are valid credentials for the server configured by corresponding build scheme (see: BikeIndex-development.xcconfig) you'll be using.
   • This test account must have already authorized the Bike Index OAuth app used in your corresponding build scheme's .xcconfig.
3. In the simulator erase all content and settings to clear out any previous credentials.
4. Run the UI tests through Xcode or bundle exec fastlane scan --only-testing "BikeIndexUITests"!

Run an individual test case

Fastlane scan can run a single test case such as: bundle exec fastlane scan --only-testing "BikeIndexUITests/ManufacturerKeyboardUITestCase".

License

Apache License 2.0