{"id":21748302,"url":"https://github.com/surfstudio/surf_flutter_starter","last_synced_at":"2025-08-20T11:20:26.496Z","repository":{"id":45622717,"uuid":"466043668","full_name":"surfstudio/surf_flutter_starter","owner":"surfstudio","description":"Made by Surf 🏄","archived":false,"fork":false,"pushed_at":"2024-04-17T06:54:48.000Z","size":2380,"stargazers_count":8,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-13T07:13:20.666Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/surfstudio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2022-03-04T08:32:05.000Z","updated_at":"2024-05-13T08:08:49.000Z","dependencies_parsed_at":"2024-04-15T06:58:43.580Z","dependency_job_id":null,"html_url":"https://github.com/surfstudio/surf_flutter_starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfstudio%2Fsurf_flutter_starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfstudio%2Fsurf_flutter_starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfstudio%2Fsurf_flutter_starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfstudio%2Fsurf_flutter_starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surfstudio","download_url":"https://codeload.github.com/surfstudio/surf_flutter_starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248675422,"owners_count":21143768,"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-11-26T08:12:57.775Z","updated_at":"2025-04-13T07:13:26.561Z","avatar_url":"https://github.com/surfstudio.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flutter Starter\n\n\u003cimg src=\"https://raw.githubusercontent.com/surfstudio/flutter-open-source/main/assets/logo_white.png#gh-dark-mode-only\" width=\"200\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/surfstudio/flutter-open-source/main/assets/logo_black.png#gh-light-mode-only\" width=\"200\"\u003e\n\n## Overview\n\nsurf_flutter_starter is a CLI tool for fast and easy creation of Flutter projects.\n\n## Usage\n\nTo activate Flutter Starter, you have to add it to pub:\n\n```sh\ndart pub global activate surf_flutter_starter\n```\n\nand then run\n\n```sh\ndart pub global run surf_flutter_starter create\n```\n\nDialog prompts will appear to follow project creation process.\n\n## Features\n\nFlutter project creation based on surf template(\u003chttps://github.com/surfstudio/surf-flutter-app-template\u003e).\nFor the time being, it can change:\n\n- Project name.\n- App ID.\n- App Label.\n\n## Getting started\n\nHelp in general:\n\n```sh\nCLI-tool for creating new Flutter projects, based on surf-flutter-app-template\n\nUsage: surf_flutter_starter \u003ccommand\u003e [arguments]\n\nGlobal options:\n-h, --help       Print this usage information.\n-v, --verbose    Print verbose output\n\nAvailable commands:\n  create   Creates new Flutter project based on Surf project template\n\n```\n\nCreate command:\n\n```sh\nUsage: surf_flutter_starter create\n-h, --help           Print this usage information.\n-c, --config-path    Specify where config.json file is located.\n```\n\n## CLI Architecture\n\n\u003cimg src=\"https://github.com/surfstudio/surf_flutter_starter/blob/main/images/CLI-Project-Generator-Structure.png\" width=\"740\"\u003e\n\n### Jobs\n\nRegular Job:\n\n```dart\n/// Atomic task, which does something and returns `Object?` on completion.\n///\n/// [Job]'s are used for project generation process. They are top-level entities,\n/// which define several technical steps of creating new project. [Job]'s are\n/// expandable. Meaning, that series of more [Job]'s can create more complex\n/// structure.\nabstract class Job {\n  /// Executes specific task for project template creation.\n  ///\n  /// Returns `Object?`\n  Future\u003cObject?\u003e execute();\n}\n```\n\nConfigurable Job:\n\n```dart\n/// [Job] requires [Config], as project-describing entity.\nabstract class ConfigurableJob extends Job {\n  /// Instance of [Config].\n  ///\n  /// Holds [Job]-specific instance of [Config], required for\n  /// [Job.execute] \u0026 project creation process.\n  late final Config config;\n\n  /// Sets up [Job] before its' [Job.execute].\n  ///\n  /// Requires [Config].\n  void setupJob(Config config) {\n    this.config = config;\n  }\n}\n```\n\n### Config\n\nConfig is a set of parameters, which specify project, that is being created.\n\n```dart\n/// Describes new project, that is being created.\n///\n/// Consists of values \u0026 parameters, that are being inserted\n/// into new project when it's being created by user. User\n/// defines those values \u0026 parameters as [ConfigParameter]s\n/// whilst interacting with CLI.\nclass Config {\n  /// ...\n}\n```\n\n## How to reach us\n\nPlease feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.\n\n[![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/SurfGear)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurfstudio%2Fsurf_flutter_starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurfstudio%2Fsurf_flutter_starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurfstudio%2Fsurf_flutter_starter/lists"}