Ember Boilerplate
The stable base upon which we build our Ember.js projects at Mirego.
Overview
Ember Boilerplate is a project that was created and maintained by Mirego, although it is now deprecated and no longer actively maintained. It provides a comprehensive starting point for Ember.js projects, with various pre-configured features and libraries. The project is available as a read-only repository.
Features
- Ember Octane: Glimmer Components, modifiers, etc.
- FastBoot server: Production-ready server for server-side rendering.
- Tests with Mocha: Includes test framework with code coverage.
- Linting: Includes ESLint, Stylelint, and ember-template-lint for code consistency.
- Formatting: Prettier is included for code formatting.
- GraphQL setup: Powered by Apollo for implementing GraphQL APIs.
- Translations: Powered by ember-intl for internationalization.
- TypeScript: Supports using TypeScript in Ember.js projects.
- CSS modules: Uses Sass/SCSS with CSS modules for modular CSS.
- README.md template: Includes a clean and useful template 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"
Usage 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"
Summary
Ember Boilerplate is a deprecated project by Mirego that provides a comprehensive starting point for Ember.js projects. It includes various features such as Ember Octane, FastBoot server, tests with Mocha, linting with ESLint and ember-template-lint, formatting with Prettier, GraphQL setup with Apollo, translations with ember-intl, TypeScript support, CSS modules with Sass/SCSS, and a clean README.md template. The project can be installed either using the GitHub template or by manually cloning and setting it up.
- Ember
Ember.js is a productive, battle-tested JavaScript framework for building modern web applications. It includes everything you need to build rich UIs that work on any device.
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Apollo
Apollo is an open-source platform for building GraphQL APIs that connects with any data source. It provides a powerful set of tools and features for developers, including client and server-side caching, real-time data synchronization, and a seamless integration with popular frontend frameworks.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Graphql
A website that uses GraphQL as a query language to manage data fetching and state management. This includes features such as a strongly typed schema, client-side caching, and declarative data fetching to streamline data management and optimize website performance.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Webpack
Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.