{"id":13568965,"url":"https://github.com/Automattic/simplenote-ios","last_synced_at":"2025-04-04T05:30:59.386Z","repository":{"id":37548868,"uuid":"65482387","full_name":"Automattic/simplenote-ios","owner":"Automattic","description":"Simplenote for iOS","archived":false,"fork":false,"pushed_at":"2024-11-02T21:18:44.000Z","size":15299,"stargazers_count":2049,"open_issues_count":135,"forks_count":285,"subscribers_count":63,"default_branch":"trunk","last_synced_at":"2024-11-02T22:16:26.908Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://simplenote.com","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Automattic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-11T15:55:22.000Z","updated_at":"2024-11-02T21:00:35.000Z","dependencies_parsed_at":"2023-11-06T08:41:29.833Z","dependency_job_id":"a78137e2-ec51-4d14-8890-1ff3a98a6b89","html_url":"https://github.com/Automattic/simplenote-ios","commit_stats":null,"previous_names":[],"tags_count":117,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fsimplenote-ios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fsimplenote-ios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fsimplenote-ios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fsimplenote-ios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Automattic","download_url":"https://codeload.github.com/Automattic/simplenote-ios/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223072814,"owners_count":17083042,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T14:00:34.076Z","updated_at":"2024-11-05T01:31:22.222Z","avatar_url":"https://github.com/Automattic.png","language":"Swift","funding_links":[],"categories":["Swift","iOS Apps"],"sub_categories":["iOS Productivity"],"readme":"# Simplenote for iOS\nA Simplenote client for iOS. Learn more about Simplenote at [Simplenote.com](https://simplenote.com).\n\n## Build Instructions\n\n### Download Xcode\n\nAt the moment *Simplenote for iOS* uses Swift 5 and requires Xcode 10.2 or newer. Xcode can be [downloaded from Apple](https://developer.apple.com/downloads/index.action).*\n\n### Third party tools\n\nWe use a few tools to help with development. To install or update the required dependencies, run the follow command on the command line:\n\n`rake dependencies`\n\n#### CocoaPods\n\nSimplenote for iOS uses [CocoaPods](http://cocoapods.org/) to manage third party libraries.\nThird party libraries and resources managed by CocoaPods will be installed by the `rake dependencies` command above.\n\n#### SwiftLint\n\nWe use [SwiftLint](https://github.com/realm/SwiftLint) to enforce a common style for Swift code. If you plan to write code, SwiftLint is going to be installed when you run `bundle exec pod install` and SwiftLint will run during the build.\nNo commit should have lint warnings or errors.\n\n### Open Xcode\n\nLaunch the workspace by running the following from the command line:\n\n`rake xcode`\n\nThis will ensure any dependencies are ready before launching Xcode.\n\nYou can also open the project by double clicking on Simplenote.xcworkspace file, or launching Xcode and choose `File` \u003e `Open` and browse to `Simplenote.xcworkspace`.\n\nOnce you have opened Simpleonte iOS in Xcode, depending on your setup, you may need to make a few changes before you can build the app.  In Xcode hit `Command + B` and see if you get any errors.  \n\n## Known Xcode Issues\n\nThere are some common errors that can happen when first getting Simplenote iOS setup.  Check these instructions to see how to fix those.\n\nIf you see `The server SSH fingerprint failed to verify` before you can build Simplenote you will need to mark the app as trusted.  To do this, tap on the warning and hit Trust\n\nIf the build fails with an `Authentication failed because the credentials were missing` error most likely you need to update the Swift Packages before being able to build the app. We use Swift Package Manager for some internal dependencies which can be found on Github.  To fetch these packages, connect Xcode to Github by going to Xcode \u003e Preferences \u003e Accounts, then enter your Github account details.  To be able to fetch these dependencies Xcode will need to be connected to a Github account via [SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)\n\nOnce you have trusted the app and the SPM packages are downloaded you should be able to build the app.  Try `Command + B` again and make sure that it builds correctly.\n\n## Setup Credentials\n\nSimplenote is powered by the [Simperium Sync'ing protocol](https://www.simperium.com). To be able to connect a development build of Simplenote iOS to the Simperium syncing service you will first need to setup app credentials.\nWe distribute **testing credentials** that help us authenticate your application, and verify that the API calls being made are valid. \n\nPlease copy the **testing Simperium credentials** as follows:\n\n```\nmkdir -p ~/.configure/simplenote-ios/secrets \u0026\u0026 cp Simplenote/SPCredentials-demo.swift ~/.configure/simplenote-ios/secrets/SPCredentials.swift\n```\n\nThis will copy the demo SPCredentials file into the correct directory with the basic details for an OSS contributor. Then edit the new `Simplenote/Credentials/SPCredentials.swift` file and change the `simperiumAppID` and `simperiumApiKey` fields to the correct values that appear in your Simperium app. If you don't see the file there, try doing a build by pressing `Command + B` and then restarting Xcode.  You should see it then.\n\nThis will allow you to compile and run the app on a device or a simulator. With the app running in the simulator you can connect to Simplenote.  Note that for testing builds you can only connect to Simplenote account using the email address and password of your account on`Simperium.com`.  You can not connect to regular Simplenote accounts in development builds.\n\n_Note: Simplenote API features such as sharing and publishing will not work with development builds._\n\n### Optional\n\nIf you want to try the screenshots generation locally, also create your own testing credentials for that target:\n\n```\nmkdir -p ~/.configure/simplenote-ios/secrets \u0026\u0026 cp Simplenote/ScreenshotsCredentials-demo.swift ~/.configure/simplenote-ios/secrets/ScreenshotsCredentials.swift\n```\n\n## Style Guidelines\n\nWe follow the WordPress iOS Style Guidelines, and we're constantly improving / adopting latest techniques.\n\n- [Swift Standard](https://github.com/wordpress-mobile/swift-style-guide)\n- [ObjC Standard](https://github.com/wordpress-mobile/objective-c-style-guide)\n\n## Contributing\n\nRead our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.\n\n## License\n\nSimplenote for iOS is an Open Source project covered by the [GNU General Public License version 2](LICENSE.md).\n\nHappy noting!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAutomattic%2Fsimplenote-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAutomattic%2Fsimplenote-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAutomattic%2Fsimplenote-ios/lists"}