Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
AmauryD committed May 31, 2024
1 parent 118f8bc commit ba63660
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# Ember-boilerplate


[![Tests](https://github.com/TRIPTYK/ember-boilerplate/actions/workflows/ci.yml/badge.svg)](https://github.com/TRIPTYK/ember-boilerplate/actions/workflows/ci.yml)

## You can use this IF

- ✅ You use tailwindcss
- ✅ You use typescript
- ✅ You use JWT based authentification
- ✅ You use pnpm
- ✅ You don't bother using TRIPTYK packages
<p>
<a href="https://vitejs.dev" target="_blank" rel="noopener noreferrer">
<img width="180" src="https://vitejs.dev/logo.svg" alt="Vite logo">
</a>
<a href="https://vitejs.dev" target="_blank" rel="noopener noreferrer">
<img width="180" src="https://emberjs.com/images/brand/ember-tomster-lockup-4c.svg" alt="Vite logo">
</a>
</p>

## Preconfigured 5.x Ember project with

### Ember Side

- Vite
- Embroider
- Typescript integration (ember-cli-typescript)
Expand All @@ -31,21 +29,21 @@
- Authorizations (ember-can)
- Pre-made registration flow (login/register/forgot-password)

### VSCODE IDE
## VSCODE IDE

- VSCODE Ready, all rules are setup for a great developing experience.

### Additional Tooling
## Additional Tooling

- With-backend: `with-backend.js` Starts the ember app with a backend synchronously.
- Code duplication: with jscpd.
- Husky: checks linting + code duplication + integration & unit tests before commiting to VSC.

### Docker
## Docker

- A docker image can be found in `images`.

### CI
## CI

A github workflow CI is provided.

Expand Down Expand Up @@ -87,7 +85,7 @@ Components are located: `app/components/`.

### API Mocking

Development mocks are in `public/mocks`.
Development mocks are in `app/handlers`.
Testing mocks are split in the `tests` folders.

## Installation
Expand All @@ -100,9 +98,8 @@ Testing mocks are split in the `tests` folders.

## Running / Development

- `ember serve`
- `pnpm start`
- Visit your app at [http://localhost:4200](http://localhost:4200).
- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

### Running Tests

Expand All @@ -115,5 +112,5 @@ Testing mocks are split in the `tests` folders.

### Building

- `ember build` (development)
- `ember build --environment production` (production)
- `pnpm build --mode=dev` (development)
- `pnpm build` (production)

0 comments on commit ba63660

Please sign in to comment.