{"id":20980404,"url":"https://github.com/cozy/create-cozy-app","last_synced_at":"2025-07-10T17:32:10.409Z","repository":{"id":26185753,"uuid":"107598482","full_name":"cozy/create-cozy-app","owner":"cozy","description":"A CLI to bootstrap a \"zero-configuration\" application for the Cozy V3 platform","archived":false,"fork":false,"pushed_at":"2025-04-03T11:09:48.000Z","size":14045,"stargazers_count":16,"open_issues_count":60,"forks_count":15,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-25T10:49:36.688Z","etag":null,"topics":["cli","cozy","template","yarn","zero-configuration"],"latest_commit_sha":null,"homepage":"https://docs.cozy.io/en/tutorials/app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cozy.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-10-19T21:03:27.000Z","updated_at":"2024-12-13T15:01:51.000Z","dependencies_parsed_at":"2022-07-09T05:00:32.006Z","dependency_job_id":"40b0e2fa-b5c4-4cfa-a43e-6f46fb125478","html_url":"https://github.com/cozy/create-cozy-app","commit_stats":{"total_commits":1601,"total_committers":28,"mean_commits":57.17857142857143,"dds":0.5852592129918801,"last_synced_commit":"a35dcf0bb0cc12b8892e73c5f62b9e3524bddea1"},"previous_names":[],"tags_count":228,"template":false,"template_full_name":null,"purl":"pkg:github/cozy/create-cozy-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozy%2Fcreate-cozy-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozy%2Fcreate-cozy-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozy%2Fcreate-cozy-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozy%2Fcreate-cozy-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cozy","download_url":"https://codeload.github.com/cozy/create-cozy-app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozy%2Fcreate-cozy-app/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263875174,"owners_count":23523354,"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":["cli","cozy","template","yarn","zero-configuration"],"created_at":"2024-11-19T05:28:20.805Z","updated_at":"2025-07-10T17:32:08.302Z","avatar_url":"https://github.com/cozy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"docs/assets/CCA_1920_1080.png\" alt=\"CCA illustration\" /\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"center\"\u003eCreate Cozy App\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/cozy/create-cozy-app/blob/master/packages/create-cozy-app/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/create-cozy-app.svg\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/cozy/create-cozy-app\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/cozy/create-cozy-app.svg\" alt=\"travis\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://renovateapp.com/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/renovate-enabled-brightgreen.svg\" alt=\"renovate\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/facebook/jest\"\u003e\n    \u003cimg src=\"https://facebook.github.io/jest/img/jest-badge.svg\" alt=\"tested with jest\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003eStart quickly your Cozy application\u003c/p\u003e\n\n### What's create-cozy-app?\n\n`create-cozy-app` is a command line tool that creates a skeleton of an application for Cozy, using Cozy libraries.\n\nThis tool can be run as an installed CLI or by using `yarn create`, see below for more information.\n\nBy default, `create-cozy-app` will use the [`cozy-scripts`](https://github.com/cozy/create-cozy-app/tree/master/packages/cozy-scripts) scripts bundle to build your app based on React.\n\n__You can find a complete tutorial about creating a Cozy application using `create-cozy-app` in [the official documentation (docs.cozy.io)](https://docs.cozy.io/en/tutorials/app/).__\n\n\n#### Requirements\n\n - NodeJS version 20+\n - [Yarn](https://yarnpkg.com): a NodeJS package manager, like `npm`;\n - a running [Cozy development environment](https://docs.cozy.io/en/tutorials/app/#install-the-development-environment)\n\n\n### Bootstrap an application\n\nYou can use `create-cozy-app` without installing it globally using `yarn create`\n([yarn create documentation](https://yarnpkg.com/lang/en/docs/cli/create/)):\n\n```\nyarn create cozy-app mycozyapp\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    You can also install the package globally.\n\n  \u003c/summary\u003e\n\n```\nyarn global add create-cozy-app\ncreate-cozy-app mycozyapp\n```\n\n⚠️ By using a locally installed CLI, you will have to update it regularly to keep the app\ntemplate up to date. It is why we recommend to use directly `yarn create` which will always uses\nthe latest version of the CLI.\n\n\u003c/details\u003e\n\nIt will\n\n* download dependencies (it may take a while, you can go grab a coffee)\n* ask you a few questions\n* then create an application skeleton inside `mycozyapp`.\n\n### Start developing\n\nℹ️ See [this tutorial](https://docs.cozy.io/en/tutorials/app/) for more information on\nhow to develop a cozy-app. Below, you'll find just the essential.\n\nYou can start developing with:\n\n```\ncd mycozyapp\nyarn start\n```\n\nThis starts a `webpack-dev-server` that continuously builds the application\ninto the `build` folder.\n\nIf not already started, you should start a `cozy-stack` serving this folder:\n\n```bash\ntouch ~/cozy.yaml # You can edit this file to configure the stack\ndocker run -ti --rm -p 8080:8080 -p 5984:5984 -p 8025:8025 -v (pwd)/build:/data/cozy-app/mycozyapp -v ~/cozy.yaml:/etc/cozy/cozy.yaml cozy/cozy-app-dev\n```\n\nYou app should now be available at `http://mycozyapp.cozy.tools:8080`.\n\n\n### Options\n\n##### `--scripts-source` (useful for hacking)\n\nYou can pass a custom scripts package using the optional `--scripts-source` option, it can be one of:\n\n- a __relative local path__ to a tarball (`fileRel:` prefix): `fileRel:./a-folder/my-cozy-scripts.tar.gz`\n- an __absolute local path__ to a tarball (`fileAbs:` prefix): `fileAbs:/root/my-cozy-scripts.tar.gz`\n- an __URL__ to a tarball (`url:` prefix): `url:https://myurl.com/my-cozy-scripts.tar.gz`\n- a specific __npm version__ (`version:` prefix): `version:0.1.5`\n- a specific __git commit/branch__ with name provided after the '#' (`git:` prefix): `git://github.com/cozy/cozy-scripts.git#master`\n\n##### `--verbose`\n\nUsing this options, `create-cozy-app` will be run in a more verbose way, useful for debugging or understanding what the script does.\n\n\n## Community\n\n### What's Cozy?\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://cozy.io\"\u003e\n    \u003cimg src=\"https://cdn.rawgit.com/cozy/cozy-site/master/src/images/cozy-logo-name-horizontal-blue.svg\" alt=\"cozy\" height=\"48\" /\u003e\n  \u003c/a\u003e\n \u003c/div\u003e\n \u003c/br\u003e\n\n[Cozy] is a platform that brings all your web services in the same private space.  With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.\n\n### Get in touch\n\nYou can reach the Cozy Community by:\n\n- Chatting with us on IRC `#cozycloud` on [Libera.Chat][libera]\n- Posting on our [Forum][forum]\n- Posting issues on the [Github repos][github]\n- Say Hi! on [Twitter][twitter]\n\n\n## License\n\n`create-cozy-app` is distributed under the MIT license.\n\nCCA logo by [@CPatchane](https://github.com/CPatchane).\n\n\n[cozy]: https://cozy.io \"Cozy Cloud\"\n[libera]: https://web.libera.chat/#cozycloud\n[forum]: https://forum.cozy.io/\n[github]: https://github.com/cozy/\n[twitter]: https://twitter.com/cozycloud\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozy%2Fcreate-cozy-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcozy%2Fcreate-cozy-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozy%2Fcreate-cozy-app/lists"}