Skip to content

Latest commit

 

History

History
85 lines (62 loc) · 3.43 KB

README.md

File metadata and controls

85 lines (62 loc) · 3.43 KB
Raw

🔒📱 OakOTP

iOS Version Swift Build Status codecov License

OakOTP is an iOS app built with SwiftUI for managing your 2FA codes.

Download

  • Supports iPhone & iPad
  • Supports scanning a QR code or entering credentials manually
  • Supports both TOTP & HOTP codes
  • Fully sync accounts with iCloud across all your devices
  • Secured with biometrics or a password
  • Built with SwiftUI utilising the MVVM pattern
  • Dependency Injection for easy mocking in tests
  • Decent Unit & UI test coverage

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

OakOTP uses Fastlane for running tests so make sure you have Fastlane setup and configured on your machine.

Installation

  1. Clone the repo 
    git clone [email protected]:AlexCatch/Oak.git
  2. Run Bundler 
    bundle install
  3. Open OakOTP.xcodeproj and configure signing for each target (Automatically managing signing will suffice.)

Running Tests

You can either run tests through Xcode or run bundle exec fastlane test from your terminal to run all unit and UI tests

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Make sure your changes are tested either with unit or UI tests. (bundle exec fastlane test)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

Contact

If you need to reach out, shoot me an email at [email protected] or you can find me on LinkedIn

Built With

A few open-source packages are used in OakOTP - you can find them listed below.

License

Distributed under the MIT License. See LICENSE for more information.