Skip to content
Simplenote for iOS
Objective-C C Swift Ruby CSS
Branch: develop
Clone or download
Latest commit 8ec1996 Sep 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.bundle Added bundle config file May 8, 2019
.circleci Fix merge conflicts Sep 19, 2019
.github Update backticks on in PR template Aug 22, 2019
External Implements SPUserInterface Jul 29, 2019
Scripts Addressing PR Feedback Aug 22, 2019
Simplenote.xcodeproj Nukes SPTableViewCell Sep 3, 2019
Simplenote.xcworkspace Removes Release Notes from workspace Jun 12, 2019
Simplenote Fix merge conflicts Sep 19, 2019
SimplenoteShare Wiring the new SPCredentials API Aug 20, 2019
SimplenoteTests Addressing PR Feedback Aug 22, 2019
config Bump version to 4.10.0.3 Sep 16, 2019
fastlane Fix metadata key Sep 14, 2019
.configure Update .configure Jul 31, 2019
.gitattributes Reduce number of conflicts in RELEASE-NOTES.txt Jul 5, 2019
.gitignore Updates gitignore Aug 22, 2019
.hound.yml Add configuration for Hound and Swiftlint May 30, 2019
.ruby-version Update CircleCI config for XCode 11 Sep 15, 2019
.swiftlint.yml Add configuration for Hound and Swiftlint May 30, 2019
CONTRIBUTING.md Removed whitespace in a filename May 2, 2019
Gemfile Udpate cocoapods Sep 20, 2019
Gemfile.lock Udpate cocoapods Sep 20, 2019
LICENSE.md Simplenote for iOS is now Open Source Software! 🚀 Aug 11, 2016
Podfile Updates Simperium to Mark 0.8.23 Aug 6, 2019
Podfile.lock Udpate cocoapods Sep 20, 2019
README.md README: Updates path Aug 28, 2019
RELEASE-NOTES.txt Update release notes. Aug 26, 2019
Rakefile Added Rakefile, updated Gemfile & Podfile May 6, 2019

README.md

Simplenote for iOS

A Simplenote client for iOS. Learn more about Simplenote at Simplenote.com.

Build Instructions

Download Xcode

At the moment Simplenote for iOS uses Swift 5 and requires Xcode 10.2 or newer. Xcode can be downloaded from Apple.*

Third party tools

We use a few tools to help with development. To install or update the required dependencies, run the follow command on the command line:

rake dependencies

CocoaPods

Simplenote for iOS uses CocoaPods to manage third party libraries. Third party libraries and resources managed by CocoaPods will be installed by the rake dependencies command above.

SwiftLint

We use SwiftLint to enforce a common style for Swift code. The app should build and work without it, but if you plan to write code, you are encouraged to install it. No commit should have lint warnings or errors.

You can set up a Git pre-commit hook to run SwiftLint automatically when committing by running:

rake git:install_hooks

This is the recommended way to include SwiftLint in your workflow, as it catches lint issues locally before your code makes its way to Github.

Alternately, a SwiftLint scheme is exposed within the project; Xcode will show a warning if you don't have SwiftLint installed.

Finally, you can also run SwiftLint manually from the command line with:

rake lint

If your code has any style violations, you can try to automatically correct them by running:

rake lint:autocorrect

Otherwise you have to fix them manually.

Open Xcode

Launch the workspace by running the following from the command line:

rake xcode

This will ensure any dependencies are ready before launching Xcode.

You can also open the project by double clicking on Simplenote.xcworkspace file, or launching Xcode and choose File > Open and browse to Simplenote.xcworkspace.

Setup Credentials

Simplenote is powered by the Simperium Sync'ing protocol. We distribute testing credentials that help us authenticate your application, and verify that the API calls being made are valid.

⚠️ Please note → We're not accepting any new Simperium accounts at this time.

After you've created your own Simperium application, copy the sample config. For example:

mkdir -p Simplenote/Credentials && cp Simplenote/SPCredentials-demo.swift Simplenote/Credentials/SPCredentials.swift

Then edit the new Simplenote/Credentials/SPCredentials.swift file and change the simperiumAppID and simperiumApiKey fields to the correct values for your new app.

This will allow you to compile and run the app on a device or a simulator.

Note: Simplenote API features such as sharing and publishing will not work with development builds.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

License

Simplenote for iOS is an Open Source project covered by the GNU General Public License version 2.

Happy noting!

You can’t perform that action at this time.