{"id":24191212,"url":"https://github.com/ember-learn/cli-guides","last_synced_at":"2025-09-21T14:32:47.014Z","repository":{"id":37579848,"uuid":"142605200","full_name":"ember-learn/cli-guides","owner":"ember-learn","description":"Step-by-step guides and tutorials for using the ember-cli to create apps and addons","archived":false,"fork":false,"pushed_at":"2024-07-02T07:32:25.000Z","size":7349,"stargazers_count":26,"open_issues_count":41,"forks_count":76,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-01-12T15:35:46.779Z","etag":null,"topics":["ember","ember-cli","emberjs","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://cli.emberjs.com","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/ember-learn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2018-07-27T17:23:55.000Z","updated_at":"2025-01-01T08:40:43.000Z","dependencies_parsed_at":"2023-07-17T05:51:31.580Z","dependency_job_id":"5fa481be-ace9-4445-b35b-205e9f164e59","html_url":"https://github.com/ember-learn/cli-guides","commit_stats":null,"previous_names":["ember-learn/cli-guides-source"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fcli-guides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fcli-guides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fcli-guides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fcli-guides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ember-learn","download_url":"https://codeload.github.com/ember-learn/cli-guides/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233761319,"owners_count":18726117,"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":["ember","ember-cli","emberjs","hacktoberfest"],"created_at":"2025-01-13T15:17:38.559Z","updated_at":"2025-09-21T14:32:41.628Z","avatar_url":"https://github.com/ember-learn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![This project uses GitHub Actions for continuous integration.](https://github.com/ember-learn/cli-guides/workflows/CI/badge.svg)](https://github.com/ember-learn/cli-guides/actions?query=workflow%3ACI)\n\n# Ember CLI guides\n\nThis repository holds the guides and tutorials for the [Ember CLI](https://github.com/ember-cli/ember-cli), a powerful tool that helps you create, develop, and build an Ember app.\n\nTo contribute to the API documentation itself, which lists properties and methods used by addons and apps, instead visit [Ember CLI](https://github.com/ember-cli/ember-cli), where the API docs are managed as code comments within the codebase.\n\nThis project replaces, updates, and adds to the content historically hosted at [https://ember-cli.com/](https://ember-cli.com/).\n\nLooking for repositories for the other parts of [emberjs.com](https://emberjs.com)?\nCheck out\n[guides-source](https://github.com/ember-learn/guides-source),\n[website](https://github.com/emberjs/website),\n[ember-api-docs](https://github.com/ember-learn/ember-api-docs),\n[super-rentals tutorial](https://github.com/ember-learn/super-rentals),\n[statusboard](https://github.com/ember-learn/statusboard),\n[deprecation-app](https://github.com/ember-learn/deprecation-app),\nand [styleguide](https://github.com/ember-learn/ember-styleguide).\n\n\n## Prerequisites\n\nYou will need the following things properly installed on your computer.\n\n* [Git](https://git-scm.com/)\n* [Node.js](https://nodejs.org/) (with npm)\n* [Ember CLI](https://ember-cli.com/)\n* [Google Chrome](https://google.com/chrome/)\n\n## Local Development\n\nThe Ember CLI Guides is a normal Ember application, so if you want to run it locally you follow the standard steps:\n\n* Clone this repository\n* `cd cli-guides-source`\n* `npm install`\n* `npm start`\n* Visit your app at [http://localhost:4200](http://localhost:4200).\n\n_Note:_ If you are developing in any online editor environment like [codesandbox.io](https://codesandbox.io) or [gitpod.io](https://gitpod.io), then you may not able to serve the application properly because of FastBoot's domain configurations. In such cases, you can disable fastboot in development mode by serving the ember app using `FASTBOOT_DISABLED=true ember serve` command.\n\nIf you then edit the Markdown files located in the `guides/` folder your\napplication should live-update with the content changes.\n\nTo run the tests you can run `npm run lint:md` and `npm test` in your terminal. `npm run lint:md` will spellcheck and enforce consistency in the Markdown files.  `npm test` will run Ember tests that have been setup and also scripts that check the Markdown\nfiles links.\n\nMarkdown linting (`lint:md`) must pass. Otherwise, it will fail in CI (continuous integration). Spellchecking uses a custom [ember-dictionary](https://github.com/maxwondercorn/ember-dictionary) with words and terms common to the Ember community, such as `SemVer`. Words and terms that are associated with a specific guide can be placed in the `.local.dic` dictionary file. Create a pull request if a word needs to be added to `ember-dictionary`.\n\n## How this app works\n\nThe guides content is in the form of Markdown files in the [guides](https://github.com/ember-learn/cli-guides/tree/main/guides) directory. An Ember app processes and serves the Markdown files. If you look at the `app` directory, you'll see there's not much in it! That's because most of the work is done through a dependency on [guidemaker](https://sea-region.github.com/empress/guidemaker), a static site generator created in Ember.\n\nThe API docs are built from the `ember-cli` source code. Deployment and hosting details can be found in the [`ember-cli.github.io`](https://github.com/ember-learn/ember-cli.github.io) repository.\n\n## Contributing\n\nDo you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do?  We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md). If you're new to writing Markdown, follow [this cheat sheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf).\n\nOverall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.\n\n\n### Adding more things to the table of contents\n\nSee `pages.yaml` in the cli-guides-source. Whatever has a URL of `index` will be shown for the top level path, like `/tutorial/`. There must be an `index.md` under each topic.\n\n### Deploying\n\nThe app is continuously deployed to Netlify when a pull request is merged and passes continuous integration.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fcli-guides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fember-learn%2Fcli-guides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fcli-guides/lists"}