Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ This will create the `miragejs` folder inside `src`. You can use any folder name
### 2. Make sure all dependencies are installed:

```
npm install --save-dev miragejs faker
npm install --save-dev miragejs @faker-js/faker
```
or, if you're using yarn:
```
yarn add -D miragejs @faker-js/faker
```

### 3. Make your project aware of Mirage JS:
Expand Down Expand Up @@ -119,7 +123,7 @@ Lastly tweak `factories`, `fixtures` and `seeds` to accommodate your own needs.

## Folder structure

- `factories`: contains the blueprints for the content to be generated by mirage. It uses [faker](https://github.com/Marak/Faker.js#readme) to generate random but credible content;
- `factories`: contains the blueprints for the content to be generated by mirage. It uses [faker](https://github.com/faker-js/faker#readme) to generate random but credible content;
- `fixtures`: contains predefined data to be served by Mirage. Use it if you have content to be served from JSON files;
- `models`: contains all models for the database entities. Every time you create a new resource or a new fixture, it is necessary to create a new model;
- `routes`: contains the routes for your API;
Expand Down
4 changes: 2 additions & 2 deletions factories/message.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
import { Factory } from 'miragejs';

/*
* Faker Github repository: https://github.com/Marak/Faker.js#readme
* Faker Github repository: https://github.com/faker-js/faker#readme
*/
import faker from 'faker';
import { faker } from '@faker-js/faker';

export default {
message: Factory.extend({
Expand Down
4 changes: 2 additions & 2 deletions factories/user.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import { randomNumber } from './utils';
import { Factory } from 'miragejs';

/*
* Faker Github repository: https://github.com/Marak/Faker.js#readme
* Faker Github repository: https://github.com/faker-js/faker#readme
*/
import faker from 'faker';
import { faker } from '@faker-js/faker';

export default {
user: Factory.extend({
Expand Down