Skip to content

Commit 45602fe

Browse files
author
hirsch88
committed
Fix readme
1 parent f26a1cd commit 45602fe

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.md

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@ npm start setup
104104
### Step 3: Serve your App
105105

106106
Go to the project dir and start your app with this npm script.
107-
<<<<<<< HEAD
108-
```
109-
=======
110107

108+
```bash
109+
npm start serve
111110
```
112111

112+
> This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
113113
> The server address will be displayed to you as `http://0.0.0.0:3000`.
114114
115115
## Scripts and Tasks
@@ -296,50 +296,6 @@ export class CreateUsers implements SeedsInterface {
296296
}
297297
```
298298
299-
<<<<<<< HEAD
300-
### Linting
301-
* Run code quality analysis using `npm start lint`. This runs tslint.
302-
* There is also a vscode task for this called `lint`.
303-
304-
### Tests
305-
* Run the unit tests using `npm start test` (There is also a vscode task for this called `test`).
306-
* Run the e2e tests using `npm start test:e2e` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
307-
308-
### Running in dev mode
309-
* Run `npm start serve` to start nodemon with ts-node, to serve the app.
310-
* The server address will be displayed to you as `http://0.0.0.0:3000`
311-
312-
### Building the project and run it
313-
* Run `npm start build` to generated all JavaScript files from the TypeScript sources (There is also a vscode task for this called `build`).
314-
* To start the builded app located in `dist` use `npm start`.
315-
316-
### Database
317-
* Run `npm start db:migrate` to migrate schema changes to the database
318-
* Run `npm start db:migrate:rollback` to rollback one migration
319-
* Run `npm start db:seed` to seed sample data into the database
320-
* Run `npm start db:reset` to rollback all migrations and migrate any migration again
321-
322-
### Console
323-
* To run your own created command enter `npm run console <command-name>`.
324-
* This list all your created commands `npm run console:help`.
325-
326-
### Scaffolding Commands
327-
All the templates for the commands are located in `src/console/templates`.
328-
329-
* `npm run console make:resource <file>` - Generates a controller, service, requests, repo, model and a migration with CRUD operations.
330-
* `npm run console make:controller <file>` - Generates a controller.
331-
* `npm run console make:service <file>` - Generates a service.
332-
* `npm run console make:repo <file>` - Generates a repository.
333-
* `npm run console make:model <file>` - Generates a model with the props and configurations.
334-
* `npm run console make:middleware <file>` - Generates a basic middleware.
335-
* `npm run console make:request <file>` - Generates a basic request.
336-
* `npm run console make:listener <file>` - Generates a basic listener.
337-
* `npm run console make:exception <file>` - Generates a basic exception.
338-
* `npm run console make:validator <file>` - Generates a custom validator.
339-
* `npm run console update:targets <file>` - Reads all the API files and generate a new `constants/Targets.ts` file out of it.
340-
341-
**Example**
342-
=======
343299
With the second parameter in the `.get(<Entity>, <args>)` you are able to create different variations of entities.
344300
345301
```typescript
@@ -352,7 +308,6 @@ export class CreateUsers implements SeedsInterface {
352308
}
353309

354310
}
355-
>>>>>>> release/3.0.0-beta
356311
```
357312
358313
Here an example with nested factories.

0 commit comments

Comments
 (0)