Skip to content

Commit b521738

Browse files
committed
Update readme
1 parent 009e380 commit b521738

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

+20-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# sparkle
22

3-
This README outlines the details of collaborating on this Ember application.
4-
A short introduction of this app could easily go here.
3+
Sparkle is a small EmberJS app that is used for the pairing exercise in a frontend engineering interview.
4+
5+
- Uses the latest version of EmberJS but sticks with Octane syntax and Glimmer components to keep it familiar and accesssible to our candidates.
6+
- Uses Mirage to mock out a backend
7+
- Uses Tailwind for styling
8+
- Provides a home route, a patients route, and an edit patient route.
9+
- Provides a patient model and a practitioner model.
10+
- Use `pnpm` as the package manager.
511

612
## Prerequisites
713

@@ -11,41 +17,42 @@ You will need the following things properly installed on your computer.
1117
- [Node.js](https://nodejs.org/) (with npm)
1218
- [Ember CLI](https://cli.emberjs.com/release/)
1319
- [Google Chrome](https://google.com/chrome/)
20+
- [pnpm](https://pnpm.io/)
1421

1522
## Installation
1623

1724
- `git clone <repository-url>` this repository
1825
- `cd sparkle`
19-
- `npm install`
26+
- `pnpm install`
2027

2128
## Running / Development
2229

23-
- `npm run start`
24-
- Visit your app at [http://localhost:4200](http://localhost:4200).
25-
- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
30+
- `pnpm run start`
31+
- Visit Sparkle at [http://localhost:4200](http://localhost:4200).
32+
- Visit the tests at [http://localhost:4200/tests](http://localhost:4200/tests).
2633

2734
### Code Generators
2835

2936
Make use of the many generators for code, try `ember help generate` for more details
3037

3138
### Running Tests
3239

33-
- `npm run test`
34-
- `npm run test:ember -- --server`
40+
- `pnpm run test`
41+
- `pnpm run test:ember -- --server`
3542

3643
### Linting
3744

38-
- `npm run lint`
39-
- `npm run lint:fix`
45+
- `pnpm run lint`
46+
- `pnpm run lint:fix`
4047

4148
### Building
4249

43-
- `npm exec ember build` (development)
44-
- `npm run build` (production)
50+
- `pnpm exec ember build` (development)
51+
- `pnpm run build` (production)
4552

4653
### Deploying
4754

48-
Specify what it takes to deploy your app.
55+
This repo should not be deployed.
4956

5057
## Further Reading / Useful Links
5158

0 commit comments

Comments
 (0)