Skip to content

Latest commit

 

History

History
262 lines (180 loc) · 11 KB

README.markdown

File metadata and controls

262 lines (180 loc) · 11 KB
Raw

OBAKit

OBAKit

OBAKit is a total rewrite of OneBusAway for iOS in the Swift programming language.

Purpose and Goals

  • This codebase is built as a set of reusable frameworks, which can be used to make new apps or augment existing apps on a wide variety of platforms.
  • This codebase is meant to provide an easy way for transit agencies to create their own custom-branded transit apps without needing to fork the OneBusAway source code.
  • This codebase is intended to be easy to understand, test, and maintain. We try to emphasize clarity over cleverness, even at the risk of being somewhat more verbose at times.

Quick Start

This project requires XcodeGen to generate Xcode project files. Third-party dependencies are installed via Xcode's Swift Package Manager.

See wiki/Get-Started for instructions.

White Labeling

The iOS codebase is a white-label product, read more about white-labeling at wiki/White-Label.

Custom Regions

You can quickly add a custom region to the app by creating a specially formed link and then tapping on it in Mobile Safari:

Example:

onebusaway://add-region?name=Unitrans&oba-url=https%3A%2F%2Fonebusaway-unitrans.onrender.com%2F

Breaking it down:

  • Scheme: onebusaway
  • Host: add-region
  • Query Params:
    • name - the name of the region
    • oba-url - the URL encoded address of the server

Internationalization and Localization

Note: There's a lot more to be written on this topic. Don't hesitate to ask questions if something is wrong or confusing.

We are using Transifex to localize OneBusAway. You can help out by visiting the OBA page on Transifex.

Install the Transifex command line client (tx) by following the instructions here: https://docs.transifex.com/client/installing-the-client

Use tx by following the instructions here: https://docs.transifex.com/client/introduction

Get an API token to use with tx by following the instructions here: https://docs.transifex.com/account/authentication

Fetch updated strings from Transifex by running the command scripts/tx_pull.

tx_pull extracts the full list of localizations that are specified in app_shared.yml, and requests the latest list of strings for each language from Transifex by calling tx pull -l {LANG CODE} under the hood.

Objective-C Compatibility

OBAKit is written almost entirely in Swift, with the exception of a few small, ancillary pieces of code. This project is designed to be usable within both Swift and Objective-C projects. Please open an issue for scenarios encountered where you are unable to effectively use the framework generated by this project in Objective-C code.

Documentation

This project uses Jazzy and Sourcekitten to generate its documentation. To rebuild documentation, you will first need to have both projects installed:

bundle install
brew install sourcekitten

Once you have the necessary tools installed, you can regenerate documentation by running the command:

scripts/docs

Configuration data for the Jazzy-generated documentation can be found in the file .jazzy.json in the root of the repository.

How-To's

Protobuf

To make modifications to the local copy of gtfs-realtime.proto, you will need to install some new tools via the brew command:

brew install protobuf
brew install swift-protobuf

Now, replace the file OBAKitCore/Models/Protobuf/gtfs-realtime.proto with the updated version, and run scripts/proto-gen.sh from the project root.

You can find the latest version of the GTFS-RT protobuf file in the https://github.com/google/transit/ repository.

Update macOS/Xcode versions for GitHub Actions CI

  1. Find the latest version of macOS and Xcode here: https://github.com/actions/runner-images/tree/main/images/macos
  2. Update the .github/obakittests.yml file accordingly.
  3. There's no step 3.

Fix "Missing package product" build errors

In Xcode: File Menu -> Packages -> Reset Package Caches

Third Party Libraries

These are third party libraries directly included inside of this project.

AwesomeSpotlight

Includes AwesomeSpotlight by Aleksandr Shoshiashvili. 
```
Copyright (c) 2017 aleksandrshoshiashvili [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```

Polyline

Includes Polyline.swift by Raphaël Mor. 
```
The MIT License (MIT)

Copyright (c) 2015 Raphaël Mor

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

ProgressHUD

Includes ProgressHUD by Related Code. 
```
v13.4

MIT License

Copyright (c) 2020 Related Code.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

SVPulsingAnnotationView

Copyright (c) 2013, Sam Vermette ([email protected]) 
```
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby
granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL,
DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
```

Visual Effects Shadow

Includes Visual Effects Shadow by Brian Coyner. 
```
https://github.com/briancoyner/Visual-Effects-Shadow

MIT License

Copyright (c) 2017 Brian Coyner

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

Apache 2.0 License

All other code is made available under the Apache 2.0 license.

Copyright 2018-Present Open Transit Software Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.