https://github.com/ember-cli/ember-welcome-page

Welcome page for Ember CLI applications
https://github.com/ember-cli/ember-welcome-page

ember-addon emberjs

Last synced: about 1 month ago
JSON representation

Welcome page for Ember CLI applications

• Host: GitHub
• URL: https://github.com/ember-cli/ember-welcome-page
• Owner: ember-cli
• License: mit
• Created: 2016-02-24T01:44:51.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-05-25T09:27:57.000Z (over 1 year ago)
• Last Synced: 2024-09-29T12:07:18.044Z (about 2 months ago)
• Topics: ember-addon, emberjs
• Language: JavaScript
• Homepage:
• Size: 2.25 MB
• Stars: 12
• Watchers: 13
• Forks: 23
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![This project uses GitHub Actions for continuous integration.](https://github.com/ember-cli/ember-welcome-page/workflows/CI/badge.svg)](https://github.com/ember-cli/ember-welcome-page/actions?query=workflow%3ACI)

# ember-welcome-page

Displays a nice welcome page for newly generated applications with links to resources.

## Installation

```sh

ember install ember-welcome-page

```

Use Glint or <template> tag? ✨

- Update your template registry to extend this addon's. Check the [Glint documentation](https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons#using-glint-enabled-addons) for more information.

    ```ts

    /* types/index.d.ts */

    import '@glint/environment-ember-loose';

    import type EmberWelcomePageRegistry from 'ember-welcome-page/template-registry';

    declare module '@glint/environment-ember-loose/registry' {

      export default interface Registry extends EmberWelcomePageRegistry, /* other addon registries */ {

        // local entries

      }

    }

    ```

- If you are using [`` tag](https://github.com/ember-template-imports/ember-template-imports), you are good to go! Use the named import to consume things.

    ```ts

    /* app/components/hello-world.{gjs,gts} */

    import { WelcomePage } from 'ember-welcome-page';

    

      

    

    ```

## Compatibility

- Ember.js v3.28 or above

- Ember CLI v3.28 or above

- Node.js v14 or above

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## License

This project is licensed under the [MIT License](LICENSE.md).