Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hirsch88 committed Nov 25, 2017
1 parent f26a1cd commit 45602fe
Showing 1 changed file with 3 additions and 48 deletions.
51 changes: 3 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ npm start setup
### Step 3: Serve your App

Go to the project dir and start your app with this npm script.
<<<<<<< HEAD
```
=======

```bash
npm start serve
```

> This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
> The server address will be displayed to you as `http://0.0.0.0:3000`.
## Scripts and Tasks
Expand Down Expand Up @@ -296,50 +296,6 @@ export class CreateUsers implements SeedsInterface {
}
```
<<<<<<< HEAD
### Linting
* Run code quality analysis using `npm start lint`. This runs tslint.
* There is also a vscode task for this called `lint`.
### Tests
* Run the unit tests using `npm start test` (There is also a vscode task for this called `test`).
* 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).
### Running in dev mode
* Run `npm start serve` to start nodemon with ts-node, to serve the app.
* The server address will be displayed to you as `http://0.0.0.0:3000`

### Building the project and run it
* Run `npm start build` to generated all JavaScript files from the TypeScript sources (There is also a vscode task for this called `build`).
* To start the builded app located in `dist` use `npm start`.

### Database
* Run `npm start db:migrate` to migrate schema changes to the database
* Run `npm start db:migrate:rollback` to rollback one migration
* Run `npm start db:seed` to seed sample data into the database
* Run `npm start db:reset` to rollback all migrations and migrate any migration again

### Console
* To run your own created command enter `npm run console <command-name>`.
* This list all your created commands `npm run console:help`.

### Scaffolding Commands
All the templates for the commands are located in `src/console/templates`.

* `npm run console make:resource <file>` - Generates a controller, service, requests, repo, model and a migration with CRUD operations.
* `npm run console make:controller <file>` - Generates a controller.
* `npm run console make:service <file>` - Generates a service.
* `npm run console make:repo <file>` - Generates a repository.
* `npm run console make:model <file>` - Generates a model with the props and configurations.
* `npm run console make:middleware <file>` - Generates a basic middleware.
* `npm run console make:request <file>` - Generates a basic request.
* `npm run console make:listener <file>` - Generates a basic listener.
* `npm run console make:exception <file>` - Generates a basic exception.
* `npm run console make:validator <file>` - Generates a custom validator.
* `npm run console update:targets <file>` - Reads all the API files and generate a new `constants/Targets.ts` file out of it.

**Example**
=======
With the second parameter in the `.get(<Entity>, <args>)` you are able to create different variations of entities.
```typescript
Expand All @@ -352,7 +308,6 @@ export class CreateUsers implements SeedsInterface {
}

}
>>>>>>> release/3.0.0-beta
```
Here an example with nested factories.
Expand Down

0 comments on commit 45602fe

Please sign in to comment.