{"id":15674609,"url":"https://github.com/javierarce/corcho","last_synced_at":"2025-05-06T23:23:29.338Z","repository":{"id":56736508,"uuid":"524374566","full_name":"javierarce/corcho","owner":"javierarce","description":"A tool to create and sync web slideshows with Figma","archived":false,"fork":false,"pushed_at":"2025-01-04T10:39:48.000Z","size":2583,"stargazers_count":19,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-31T03:51:43.430Z","etag":null,"topics":["figma","figma-api","slideshow"],"latest_commit_sha":null,"homepage":"https://javierarce.github.io/corcho","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/javierarce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-08-13T11:04:20.000Z","updated_at":"2025-01-04T10:39:52.000Z","dependencies_parsed_at":"2024-12-18T01:20:22.134Z","dependency_job_id":"7fd9f8b2-8523-4009-8411-dea7f63e392e","html_url":"https://github.com/javierarce/corcho","commit_stats":{"total_commits":77,"total_committers":1,"mean_commits":77.0,"dds":0.0,"last_synced_commit":"ddca56e193e3eb055cb304ff45328095bc9d30e5"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Fcorcho","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Fcorcho/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Fcorcho/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Fcorcho/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javierarce","download_url":"https://codeload.github.com/javierarce/corcho/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252784101,"owners_count":21803607,"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":["figma","figma-api","slideshow"],"created_at":"2024-10-03T15:48:08.653Z","updated_at":"2025-05-06T23:23:29.319Z","avatar_url":"https://github.com/javierarce.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Corcho\n\nCorcho (/ˈkoɾt͡ʃo/) is a tool that creates and sync web slideshows using the contents of a Figma file. You can then use GitHub Pages to host your slideshow on the web and have it automatically updated using GitHub Actions.\n\n## How to run Corcho\n\n1. Create a file in Figma and your slides as frames.\n2. Create a non-expiring [Figma personal access token](https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens).\n3. Copy the file id of your Figma file (which is the string of random alphanumeric characters found in the URL after `figma.com/design/`)\n\n### On GitHub Pages\n\n1. Fork this project and add two secrets:\n\n- `FIGMA_FILE`: with the file id.\n- `FIGMA_TOKEN`: with your Figma Personal Access Token.\n\nOptionally, add `FILE_FORMAT` to specify the format of the exported images. The default is `jpg`, but you can also use `png` or `svg`.\n\n2. Enable:\n\n- GitHub pages for the `main` branch.\n- The deploy workflow (by visiting the Actions tab).\n\n#### Customization\n\nBy default the cronjob of the GitHub Action will run every hour on the hour,\nbut you can change the scheduling to be more frequent. Here's an example of a\njob that gets executed every 5 minutes (which is the shortest interval allowed):\n\n```\nname: Cron\non:\n  push:\n    branches: [ \"main\" ]\n  schedule:\n    - cron: \"*/5 * * * *\" # Runs every 5 minutes\n```\n\nIf you don't need continuous updates, you can remove the .github/workflows/deploy.yml file.\n\nAlso, please note that free accounts have a limit of 500 MB and 2,000\nminutes of run time per month. Please check the [included storage and\nminutes](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes)\navailable for your account type.\n\n### Locally\n\n1. Clone this project\n2. Rename the `.env.sample` file to `.env` and update it:\n\n- `FIGMA_FILE`: with the file id.\n- `FIGMA_TOKEN`: with your Figma Personal Access Token.\n\n3. Install the dependencies with `yarn install` or `npm install`\n4. Run the project with `yarn start` or `npm run start`\n5. Open the `index.html` file in your browser using a local server.\n\n## Shortcuts\n\n| Key                                                 | Action                                            |\n| :-------------------------------------------------- | :------------------------------------------------ |\n| \u003ckbd\u003e←\u003c/kbd\u003e or \u003ckbd\u003eSpace\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e | Previous slide                                    |\n| \u003ckbd\u003e→\u003c/kbd\u003e or \u003ckbd\u003eSpace\u003c/kbd\u003e                    | Next slide                                        |\n| \u003ckbd\u003eJ\u003c/kbd\u003e or \u003ckbd\u003ePage Down\u003c/kbd\u003e                | Next page                                         |\n| \u003ckbd\u003eK\u003c/kbd\u003e or \u003ckbd\u003ePage Up\u003c/kbd\u003e                  | Previous page                                     |\n| \u003ckbd\u003eTab\u003c/kbd\u003e                                      | Open navigation                                   |\n| \u003ckbd\u003eF\u003c/kbd\u003e                                        | Toggle fullscreen                                 |\n| \u003ckbd\u003eEsc\u003c/kbd\u003e                                      | Exit fullscreen                                   |\n| \u003ckbd\u003eC\u003c/kbd\u003e                                        | Toggle comments                                   |\n| \u003ckbd\u003eR\u003c/kbd\u003e                                        | Go to the first slide of the current presentation |\n\n### When the navigation is open\n\n| Key                                               | Action           |\n| :------------------------------------------------ | :--------------- |\n| \u003ckbd\u003e←\u003c/kbd\u003e or \u003ckbd\u003eTab\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e | Previous page    |\n| \u003ckbd\u003e→\u003c/kbd\u003e or \u003ckbd\u003eTab\u003c/kbd\u003e                    | Next page        |\n| \u003ckbd\u003eEnter\u003c/kbd\u003e                                  | Select page      |\n| \u003ckbd\u003eEsc\u003c/kbd\u003e                                    | Close navigation |\n\n## Example\n\n- [Figma file](https://www.figma.com/file/pCi2wnm9y4HsYNANvXRiGc/Corcho)\n- [Slideshow](https://javierarce.github.io/corcho)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavierarce%2Fcorcho","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjavierarce%2Fcorcho","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavierarce%2Fcorcho/lists"}