Skip to content

Commit f7c351a

Browse files
author
hirsch88
committed
Adjust documentation
1 parent 613b1f8 commit f7c351a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ Create a new database with the name you have in your `.env`-file.
6767

6868
Then setup your application environment.
6969
```
70-
npm run setup
70+
nps setup
7171
```
7272

7373
> This installs all dependencies with yarn. After that it migrates the database and seeds some test data into it. So after that your development environment is ready to use.
7474
7575
### Step 3: Serve your App
7676
Go to the project dir and start your app with this npm script.
7777
```
78-
npm run serve
78+
nps serve
7979
```
8080

8181
> This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
@@ -148,26 +148,26 @@ All script are defined in the package.json file, but the most important ones are
148148
* Install all dependencies with `yarn install`
149149

150150
### Linting
151-
* Run code quality analysis using `npm run lint`. This runs tslint.
151+
* Run code quality analysis using `nps lint`. This runs tslint.
152152
* There is also a vscode task for this called `lint`.
153153

154154
### Tests
155155
* Run the unit tests using `npm test` (There is also a vscode task for this called `test`).
156-
* Run the e2e tests using `npm run test:e2e` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
156+
* Run the e2e tests using `nps test:e2e` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
157157

158158
### Running in dev mode
159-
* Run `npm run serve` to start nodemon with ts-node, to serve the app.
159+
* Run `nps serve` to start nodemon with ts-node, to serve the app.
160160
* The server address will be displayed to you as `http://0.0.0.0:3000`
161161

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

166166
### Database
167-
* Run `npm run db:migrate` to migrate schema changes to the database
168-
* Run `npm run db:migrate:rollback` to rollback one migration
169-
* Run `npm run db:seed` to seed sample data into the database
170-
* Run `npm run db:reset` to rollback all migrations and migrate any migration again
167+
* Run `nps db:migrate` to migrate schema changes to the database
168+
* Run `nps db:migrate:rollback` to rollback one migration
169+
* Run `nps db:seed` to seed sample data into the database
170+
* Run `nps db:reset` to rollback all migrations and migrate any migration again
171171

172172
### Console
173173
* To run your own created command enter `npm run console <command-name>`.

0 commit comments

Comments
 (0)