Skip to content

Commit 5aa31a5

Browse files
author
hirsch88
committed
Adjust documentation about nps
1 parent b7f309a commit 5aa31a5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

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

6969
Then setup your application environment.
7070
```
71-
nps setup
71+
npm start setup
7272
```
7373

7474
> 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.
7575
7676
### Step 3: Serve your App
7777
Go to the project dir and start your app with this npm script.
7878
```
79-
nps serve
79+
npm start serve
8080
```
8181

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

151151
### Linting
152-
* Run code quality analysis using `nps lint`. This runs tslint.
152+
* Run code quality analysis using `npm start lint`. This runs tslint.
153153
* There is also a vscode task for this called `lint`.
154154

155155
### Tests
156-
* Run the unit tests using `nps test` (There is also a vscode task for this called `test`).
157-
* 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).
156+
* Run the unit tests using `npm start test` (There is also a vscode task for this called `test`).
157+
* 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).
158158

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

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

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

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

0 commit comments

Comments
 (0)