Awesome
⚠️ This project is deprecated and no longer maintained by Mirego. It’s only available as a read-only repository.
<div align="center"> <img src="https://user-images.githubusercontent.com/11348/51911477-f2b17880-239f-11e9-89aa-8cf94e957155.png" width="600" /> <p><br />This repository is the stable base upon which we build our Ember.js projects at Mirego.<br />We want to share it with the world so you can build awesome Ember.js applications too.</p> <a href="https://github.com/mirego/ember-boilerplate/actions/workflows/ci.yaml"><img src="https://github.com/mirego/ember-boilerplate/actions/workflows/ci.yaml/badge.svg" /></a> </div>Introduction
To learn more about why we created and maintain this boilerplate project, read our blog post.
Content
This boilerplate comes with batteries included, you’ll find:
- Ember Octane: Glimmer Components, modifiers, etc.
- A battle-tested production-ready FastBoot server
- Tests with mocha, with coverage
- Linting with eslint, stylelint and ember-template-lint
- Formatting with Prettier
- A GraphQL setup powered by Apollo
- Translations powered by ember-intl
- TypeScript
- CSS modules with Sass/SCSS
- A clean and useful
README.mdtemplate (in both english and french)
Usage
With GitHub template
- Click on the Use this template button to create a new repository
- Clone your newly created project (
git clone https://github.com/you/repo.git) - Run the boilerplate setup script (
./boilerplate-setup.sh your-project-name) - Commit the changes (
git commit -a -m "Rename ember-boilerplate parts")
Without GitHub template
- Clone this project (
git clone https://github.com/mirego/ember-boilerplate.git) - Delete the internal Git directory (
rm -rf .git) - Run the boilerplate setup script (
./boilerplate-setup.sh your-project-name) - Create a new Git repository (
git init) - Create the initial Git commit (
git commit -a -m "Initial commit")
Preferred libraries
Some batteries aren’t included since all projects have their own needs and requirements. Here’s a list of our preferred libraries to help you get started:
| Category | Libraries |
|---|---|
| Animations | ember-animated |
| Click outside event | ember-click-outside |
| Custom calendar | ember-power-calendar |
| Custom datepicker | ember-power-datepicker |
| Custom select | ember-power-select |
| File upload | ember-file-upload |
| Flash messages | ember-cli-flash |
| Isomorphic cookie management | ember-cookies |
| Isomorphic locale detection | ember-best-language |
| List sorting | ember-sortable |
| Modal dialog | ember-modal-dialog |
| Permissions management | ember-can |
| Sticky element | ember-sticky-element |
| CSS transitions | ember-css-transitions |
License
Ember Boilerplate is © 2015-2020 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md file.
The glasses logo is based on this lovely icon by Daniela Baptista, from The Noun Project. Used under a Creative Commons BY 3.0 license.
About Mirego
Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.
We also love open-source software and we try to give back to the community as much as we can.