{"id":25118956,"url":"https://github.com/alschmut/easyframecommand","last_synced_at":"2025-04-02T13:12:56.456Z","repository":{"id":276090427,"uuid":"924337511","full_name":"alschmut/EasyFrameCommand","owner":"alschmut","description":"A swift CLI to create framed AppStore screenshots from custom SwiftUI layout","archived":false,"fork":false,"pushed_at":"2025-03-28T17:33:38.000Z","size":2529,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T13:12:52.005Z","etag":null,"topics":["appstore","automation","cli","fastlane","frame","frameit","layout","playstore","swift","swiftui"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alschmut.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-01-29T20:26:50.000Z","updated_at":"2025-03-28T17:33:41.000Z","dependencies_parsed_at":"2025-02-06T08:34:42.989Z","dependency_job_id":"b7156442-a862-44fd-b6e1-06edaf18335c","html_url":"https://github.com/alschmut/EasyFrameCommand","commit_stats":null,"previous_names":["alschmut/easyframecommand"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alschmut%2FEasyFrameCommand","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alschmut%2FEasyFrameCommand/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alschmut%2FEasyFrameCommand/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alschmut%2FEasyFrameCommand/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alschmut","download_url":"https://codeload.github.com/alschmut/EasyFrameCommand/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246819786,"owners_count":20839095,"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":["appstore","automation","cli","fastlane","frame","frameit","layout","playstore","swift","swiftui"],"created_at":"2025-02-08T04:23:25.602Z","updated_at":"2025-04-02T13:12:56.448Z","avatar_url":"https://github.com/alschmut.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EasyFrameCommand\n`easy-frame` is a lightweight Swift command-line tool for generating framed App Store screenshots using a custom SwiftUI layout. Fork this Swift package to customize the SwiftUI layout and create tailored App Store screenshots that match your branding.\n\n![Framed Example Screenshots](example.png)\n\n## Who is this tool for?\nThis Swift package is ideal for indie Swift developers who value:  \n- **Automation** over manual screenshot creation  \n- **Full design control** over relying on premade templates with limited customization options\n- **A free and open-source solution** over paid alternatives\n\n## Getting started\nTo generate screenshots like in the example above - using the implementation as-is, just follow the below steps:\n1. Set up the directory structure as shown in the example below. Place your unframed raw screenshots in the `raw-screenshots` directory, organized by locale.  \n    ```\n    parent-folder/\n        raw-screenshots/\n            EasyFrame.json\n            de-DE/\n                iPhone 15 Pro Max-1-calendar.png\n                iPhone 15 Pro Max-2-list.png\n                iPhone 15 Pro Max-3-add-entry.png\n                iPad Pro (12.9-inch) (6th generation)-1-calendar.png\n                iPad Pro (12.9-inch) (6th generation)-2-list.png\n                iPad Pro (12.9-inch) (6th generation)-3-add-entry.png\n            en-GB/\n                iPhone 15 Pro Max-1-calendar.png\n                iPhone 15 Pro Max-2-list.png\n                iPhone 15 Pro Max-3-add-entry.png\n                iPad Pro (12.9-inch) (6th generation)-1-calendar.png\n                iPad Pro (12.9-inch) (6th generation)-2-list.png\n                iPad Pro (12.9-inch) (6th generation)-3-add-entry.png\n    ```\n   - If you use Fastlane to generate unframed screenshots, its output directory structure already meets `easy-frame`'s requirements. Just ensure that the `output_directory` is set to `raw-screenshots`.  \n        ```ruby\n        capture_ios_screenshots(\n            devices: [\"iPhone 15 Pro Max\", \"iPad Pro (12.9-inch) (6th generation)\"],\n            languages: [\"de-DE\", \"en-GB\"],\n            scheme: ENV[\"XCODE_SCHEME_UI_TEST\"],\n            output_directory: \"./fastlane/raw-screenshots\"\n        )\n        ```\n1. Create an `EasyFrame.json` configuration file based on the below [Example EasyFrame.json](#example-easyframejson). The config defines each App Store page with:  \n    - localized texts, which will be displayed on the framed screenshot  \n    - a screenshot name, which must partially match the raw screenshot filenames\n1. Run the local `easy-frame` swift package command to generate framed screenshots into the `parent-folder/screenshots/` directory:\n    ```sh\n    cd path/to/EasyFrameCommandProject\n    swift run easy-frame path/to/parent-folder\n    ```\n\n## Which devices are supported?\nSee [Sources/EasyFrameCommand/Model/SupportedDevice.swift](Sources/EasyFrameCommand/Model/SupportedDevice.swift). The device frames have been taken from https://github.com/fastlane/frameit-frames.\n\n## Where to adjust the SwiftUI layout?\nSee [Sources/EasyFrameCommand/View/ScreenshotView.swift](Sources/EasyFrameCommand/View/ScreenshotView.swift)\n    \n## Example directory structure\n```\nparent-folder/\n    raw-screenshots/ (the locale folders contains the unframed raw screenshots)\n        EasyFrame.json\n        de-DE/\n            iPhone 15 Pro Max-1-calendar.png\n            iPhone 15 Pro Max-2-list.png\n            iPhone 15 Pro Max-3-add-entry.png\n            iPad Pro (12.9-inch) (6th generation)-1-calendar.png\n            iPad Pro (12.9-inch) (6th generation)-2-list.png\n            iPad Pro (12.9-inch) (6th generation)-3-add-entry.png\n        en-GB/\n            iPhone 15 Pro Max-1-calendar.png\n            iPhone 15 Pro Max-2-list.png\n            iPhone 15 Pro Max-3-add-entry.png\n            iPad Pro (12.9-inch) (6th generation)-1-calendar.png\n            iPad Pro (12.9-inch) (6th generation)-2-list.png\n            iPad Pro (12.9-inch) (6th generation)-3-add-entry.png\n    screenshots/ (this folder will be generated by easy-frame with the framed screenshots)\n        de-DE/\n            iPhone 15 Pro Max-1-calendar.jpg\n            iPhone 15 Pro Max-2-list.jpg\n            iPhone 15 Pro Max-3-add-entry.jpg\n            iPad Pro (12.9-inch) (6th generation)-1-calendar.jpg\n            iPad Pro (12.9-inch) (6th generation)-2-list.jpg\n            iPad Pro (12.9-inch) (6th generation)-3-add-entry.jpg\n        en-GB/\n            iPhone 15 Pro Max-1-calendar.jpg\n            iPhone 15 Pro Max-2-list.jpg\n            iPhone 15 Pro Max-3-add-entry.jpg\n            iPad Pro (12.9-inch) (6th generation)-1-calendar.jpg\n            iPad Pro (12.9-inch) (6th generation)-2-list.jpg\n            iPad Pro (12.9-inch) (6th generation)-3-add-entry.jpg\n```\n\n## Example EasyFrame.json\n```json\n{\n    \"pages\": [\n        {\n            \"languages\": [\n                { \"locale\": \"en-GB\", \"title\": \"Title 1 EN\", \"description\": \"Description\" },\n                { \"locale\": \"de-DE\", \"title\": \"Title 1 DE\", \"description\": \"Description\" }\n            ],\n            \"screenshot\": \"1-calendar\"\n        },\n        {\n            \"languages\": [\n                { \"locale\": \"en-GB\", \"title\": \"Title 2 EN\", \"description\": \"Description\" },\n                { \"locale\": \"de-DE\", \"title\": \"Title 2 DE\", \"description\": \"Description\" }\n            ],\n            \"screenshot\": \"2-list\"\n        },\n        {\n            \"languages\": [\n                { \"locale\": \"en-GB\", \"title\": \"Title 3 EN\", \"description\": \"Description\" },\n                { \"locale\": \"de-DE\", \"title\": \"Title 3 DE\", \"description\": \"Description\" }\n            ],\n            \"screenshot\": \"3-add-entry\"\n        }\n    ]\n}\n```\n\n## Acknowledgments\nThanks to [FrameKit](https://github.com/ainame/FrameKit) and fastlane [frameit](https://docs.fastlane.tools/actions/frameit/), which both inspired me and made this swift package possible.\n\n## Roadmap\nThere is no planned roadmap or a guarantee of ongoing maintenance. This Swift package is intended to be forked and serves as a solid starting point for further customization 😉\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falschmut%2Feasyframecommand","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falschmut%2Feasyframecommand","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falschmut%2Feasyframecommand/lists"}