{"id":19499557,"url":"https://github.com/stackbit/create-stackbit-app","last_synced_at":"2025-07-01T14:03:02.498Z","repository":{"id":39883521,"uuid":"467114316","full_name":"stackbit/create-stackbit-app","owner":"stackbit","description":"CLI tool for starting a new Stackbit site or adding Stackbit to an existing site","archived":false,"fork":false,"pushed_at":"2023-06-29T19:35:22.000Z","size":71,"stargazers_count":5,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-06-29T20:27:53.833Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/stackbit.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":"2022-03-07T13:52:30.000Z","updated_at":"2023-05-26T17:29:01.000Z","dependencies_parsed_at":"2023-02-17T07:01:01.816Z","dependency_job_id":null,"html_url":"https://github.com/stackbit/create-stackbit-app","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-stackbit-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-stackbit-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-stackbit-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-stackbit-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackbit","download_url":"https://codeload.github.com/stackbit/create-stackbit-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224019617,"owners_count":17242176,"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-10T22:04:50.983Z","updated_at":"2024-11-10T22:04:51.815Z","avatar_url":"https://github.com/stackbit.png","language":"JavaScript","readme":"# create-stackbit-app\n\nRun `npx create-stackbit-app` in your terminal to create a new Stackbit application or add Stackbit into an existing site.\n\n## Usage\n\nTo create a new Stackbit project from a starter, run the following command:\n\n```txt\nnpx create-stackbit-app@latest [dir]\n```\n\nTo see a full list of options use the `--help` flag:\n\n```txt\n\u003e npx create-stackbit-app@latest --help\n\nOptions:\n      --version  Show version number                                   [boolean]\n  -s, --starter  Choose a starter                     [choices: \"nextjs\", \"...\"]\n  -e, --example  Start from an example        [choices: \"algolia-search\", \"...\"]\n      --help     Show help                                             [boolean]\n```\n\n### Choosing a Starter\n\nUse the `--starter` option for specifying a starter. Run the command with the `--help` flag to see a full list of available starters.\n\n```txt\nnpx create-stackbit-app@latest --starter ts-nextjs\n```\n\nIf no starter option is provided, [the default starter](https://github.com/stackbit-themes/nextjs-starter) is used.\n\n### Starting from an Example\n\nUse the `--example` option to start a project from an example. Run the command with the `--help` flag to see a full list of available starters.\n\n```txt\nnpx create-stackbit-app@latest --example algolia-search\n```\n\nThis will create a new project matching the name of the example, unless overridden (see below). [See here for a full list of starters](https://github.com/stackbit-themes/stackbit-examples).\n\n### Setting Project Directory\n\nPass a directory name as the only argument when running the command. For example, if you wanted your directory to be name `my-site`, the command would look something like this:\n\n```txt\nnpx create-stackbit-app@latest my-site\n```\n\nIf no name is provided, the directory will be `my-stackbit-site` for starters or will match the name of the example if starting from an example. If the directory already exists, a timestamp value will be appended to the directory name to ensure uniqueness.\n\n## Adding Stackbit to Existing Projects\n\nThe script detects when you may be working with an existing project (it looks for a `package.json` file in the working directory).\n\nIf in an existing project, the script asks if you'd like to add Stackbit to the project. Today, this only prints a resource URL. If you choose _no_, the command exits.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackbit%2Fcreate-stackbit-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackbit%2Fcreate-stackbit-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackbit%2Fcreate-stackbit-app/lists"}