diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ddaee10 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# ember-polaris-pokedex + +This README outlines the details of collaborating on this Ember application. +A short introduction of this app could easily go here. + +## Prerequisites + +You will need the following things properly installed on your computer. + +- [Git](https://git-scm.com/) +- [Node.js](https://nodejs.org/) +- [pnpm](https://pnpm.io/) +- [Ember CLI](https://cli.emberjs.com/release/) +- [Google Chrome](https://google.com/chrome/) + +## Installation + +- `git clone ` this repository +- `cd ember-polaris-pokedex` +- `pnpm install` + +## Running / Development + +- `pnpm start` +- Visit your app at [http://localhost:4200](http://localhost:4200). +- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). + +### Code Generators + +Make use of the many generators for code, try `ember help generate` for more details + +### Running Tests + +- `pnpm test` +- `pnpm test:ember --server` + +### Linting + +- `pnpm lint` +- `pnpm lint:fix` + +### Building + +- `pnpm ember build` (development) +- `pnpm build` (production) + +### Deploying + +Specify what it takes to deploy your app. + +## Further Reading / Useful Links + +- [ember.js](https://emberjs.com/) +- [ember-cli](https://cli.emberjs.com/release/) +- Development Browser Extensions + - [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) + - [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) diff --git a/README.md b/README.md index ddaee10..b07e578 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,34 @@ -# ember-polaris-pokedex +# Ember Polaris Pokedex -This README outlines the details of collaborating on this Ember application. -A short introduction of this app could easily go here. +*A reference application to showcase what the [Ember Polaris](https://emberjs.com/editions/polaris/) edition looks like.* -## Prerequisites +## Technologies -You will need the following things properly installed on your computer. +The app is built using the latest bleeding-edge available for Ember apps: -- [Git](https://git-scm.com/) -- [Node.js](https://nodejs.org/) -- [pnpm](https://pnpm.io/) -- [Ember CLI](https://cli.emberjs.com/release/) -- [Google Chrome](https://google.com/chrome/) +- ⚡️ Vite-based Embroider +- 🔥 Volar-based Glint +- 💙 Native Ember TypeScript types from source +- 📦 Template-tag components ('.gjs', '.gts') +- 🚀 Warp Drive -## Installation +It also embraces web standards by making use of: -- `git clone ` this repository -- `cd ember-polaris-pokedex` -- `pnpm install` +- 🔗 View transition API +- 🎥 Scroll-driven animations -## Running / Development +

+ Ember + Embroider + Vite + Volar + Glint + TypeScript + Warp Drive + Glimmer TS + TailwindCSS +

-- `pnpm start` -- Visit your app at [http://localhost:4200](http://localhost:4200). -- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). +## Contributing -### Code Generators - -Make use of the many generators for code, try `ember help generate` for more details - -### Running Tests - -- `pnpm test` -- `pnpm test:ember --server` - -### Linting - -- `pnpm lint` -- `pnpm lint:fix` - -### Building - -- `pnpm ember build` (development) -- `pnpm build` (production) - -### Deploying - -Specify what it takes to deploy your app. - -## Further Reading / Useful Links - -- [ember.js](https://emberjs.com/) -- [ember-cli](https://cli.emberjs.com/release/) -- Development Browser Extensions - - [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) - - [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) +If you want to contribute to this project, please read [CONTRIBUTING.md](CONTRIBUTING.md).