{"id":20206634,"url":"https://github.com/useflyyer/flyyer-official","last_synced_at":"2026-04-21T03:32:58.205Z","repository":{"id":41781595,"uuid":"362628721","full_name":"useflyyer/flyyer-official","owner":"useflyyer","description":"Official templates for Flyyer.io | https://flyyer.io/@/flyyer/official","archived":false,"fork":false,"pushed_at":"2023-01-07T07:06:01.000Z","size":6998,"stargazers_count":1,"open_issues_count":9,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-03T09:43:54.474Z","etag":null,"topics":["flyyer","image-generation","og-images","react","twitter-cards","typescript"],"latest_commit_sha":null,"homepage":"https://flyyer.io/@/flyyer/official","language":"TypeScript","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/useflyyer.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}},"created_at":"2021-04-28T23:02:02.000Z","updated_at":"2021-09-21T21:37:12.000Z","dependencies_parsed_at":"2023-02-06T14:31:00.442Z","dependency_job_id":null,"html_url":"https://github.com/useflyyer/flyyer-official","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/useflyyer/flyyer-official","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fflyyer-official","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fflyyer-official/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fflyyer-official/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fflyyer-official/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/useflyyer","download_url":"https://codeload.github.com/useflyyer/flyyer-official/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fflyyer-official/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32075241,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T02:38:07.213Z","status":"ssl_error","status_checked_at":"2026-04-21T02:38:06.559Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["flyyer","image-generation","og-images","react","twitter-cards","typescript"],"created_at":"2024-11-14T05:25:23.044Z","updated_at":"2026-04-21T03:32:58.184Z","avatar_url":"https://github.com/useflyyer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌠 Flyyer-Official\n\nFeel free to checkout the latest documentation at [docs.flyyer.io](https://docs.flyyer.io) 📖\n\n## Development\n\nYou can start a development server at [http://localhost:7777](http://localhost:7777) with:\n\n```sh\nnpm run start\n\n# Custom port and host\nnpm run start --port 3000 --host 0.0.0.0\n```\n\nThen preview your template at [https://useflyyer.github.io/studio](https://useflyyer.github.io/studio)\n\n[![flyyer-studio screenshot](https://raw.githubusercontent.com/flyyer/flyyer-studio/main/.github/screenshot.png)](https://useflyyer.github.io/studio)\n\n## Deployment\n\nOnce you are ready to deploy to production please remember to build the project first:\n\n```sh\nNODE_ENV=production npm run build\n```\n\nGet your Flyyer key from [https://flyyer.io/dashboard/_/settings](https://flyyer.io/dashboard/_/settings) and set it as an environment variable:\n\n```sh\n# in your terminal\nexport FLYYER_KEY=...\n```\n\nAlternatively you can create a `.env` file:\n\n```sh\n# .env\nFLYYER_KEY=...\n```\n\nDeploy to production\n\n```sh\nnpm run deploy\n```\n\nYou can find the live URL for your deck in the terminal output, it is something like: `https://cdn.flyyer.io/render/v2/tenant/deck/template`.\n\n## Usage\n\nAppend queryparams to your URLs and we will set those as props when rendering.\n\n![Resultant flyyer live image](https://github.com/useflyyer/create-flyyer-app/blob/master/.github/assets/result-1.png?raw=true)\n\n![Resultant flyyer live image](https://github.com/useflyyer/create-flyyer-app/blob/master/.github/assets/result-2.png?raw=true)\n\nNext steps:\n\n* Use our official libraries to format URLs https://docs.flyyer.io/docs/libraries\n* Read our guides to integrate this into your software: https://docs.flyyer.io/guides\n\n## FAQ \u0026 Caveats\n\n### What is Flyyer studio?\n\nIt's a browser app that opens your local server (localhost:7777) in multiple _iframes_ so you can have a better developer experience. It works best on Firefox.\n\n### SCSS Support\n\nSure. Install `npm install --save sass` and just import your SASS/SCSS files just like: `import \"/styles.scss\"`.\n\n\u003e See: https://docs.flyyer.io/docs/features/styles\n\n### Custom fonts\n\nRefer to https://docs.flyyer.io/docs/features/fonts. If you are building a template for the marketplace and want to support on-the-fly fonts you can use: [flyyer/use-googlefonts](https://github.com/useflyyer/use-googlefonts).\n\n### Nested directories\n\n**This is not implemented yet. Please prefer a flat `/templates` directory.** This means you have to avoid folders inside `/templates`.\n\nFolders outside `/templates` is ok 👍\n\n### Development server crashes or stop previewing\n\nThe development server (`npm run start`) can be buggy sometimes. Please restart the server if you encounter any problems.\n\n---\n\n\u003e Default image credits: [Photo by Osvaldo Castillo from Pexels](https://images.pexels.com/photos/3402313/pexels-photo-3402313.jpeg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseflyyer%2Fflyyer-official","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuseflyyer%2Fflyyer-official","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseflyyer%2Fflyyer-official/lists"}