Skip to content

Commit

Permalink
chore: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@shimks
shimks committed May 25, 2018
1 parent 801436f commit dba531f
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 22 deletions.
3 changes: 3 additions & 0 deletions docs/site/Application-generator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ lb4 [app] [options] [<name>]
`--loopbackBuild` : Add @loopback/build module's script set to LoopBack4
application project.

`--vscode`: Add VSCode config files to LoopBack4 application project

{% include_relative includes/CLI-std-options.md %}

### Arguments
Expand Down Expand Up @@ -66,6 +68,7 @@ The tool will prompt you for:
- [`prettier`](https://www.npmjs.com/package/prettier)
- [`mocha`](https://www.npmjs.com/package/mocha)
- [`@loopback/build`](https://www.npmjs.com/package/@loopback/build)
- [`vscode`](https://code.visualstudio.com/)

### Output

Expand Down
3 changes: 3 additions & 0 deletions docs/site/Extension-generator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ lb4 extension [options] [<name>]
`--loopbackBuild` : Add @loopback/build module's script set to LoopBack4
extension project.

`--vscode`: Add VSCode config files to LoopBack4 application project

{% include_relative includes/CLI-std-options.md %}

### Arguments
Expand Down Expand Up @@ -60,3 +62,4 @@ The tool will prompt you for:
- [`prettier`](https://www.npmjs.com/package/prettier)
- [`mocha`](https://www.npmjs.com/package/mocha)
- [`@loopback/build`](https://www.npmjs.com/package/@loopback/build)
- [`vscode`](https://code.visualstudio.com/)
2 changes: 1 addition & 1 deletion docs/site/Getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Answer the prompts as follows:
? Project description: Getting started tutorial
? Project root directory: (getting-started)
? Application class name: StarterApplication
? Select project build settings: Enable tslint, Enable prettier, Enable mocha, Enable loopbackBuild
? Select project build settings: Enable tslint, Enable prettier, Enable mocha, Enable loopbackBuild, Enable vscode
```

### Starting the project
Expand Down
43 changes: 22 additions & 21 deletions docs/site/todo-tutorial-scaffolding.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ $ lb4 app
◉ Enable prettier
◉ Enable mocha
◉ Enable loopbackBuild
◉ Enable vscode
# npm will install dependencies now
Application todo-list is now created in todo-list.
```
Expand Down Expand Up @@ -72,27 +73,27 @@ tslint.build.json
tslint.json
```

| File | Purpose |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| index.ts | Allows importing contents of the `src` folder (for use elsewhere) |
| index.js | Top-level wireup for execution of the application. |
| package.json | Your application's package manifest. See [package.json](https://docs.npmjs.com/files/package.json) for details. |
| tsconfig.json | The TypeScript project configuration. See [tsconfig.json](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for details. |
| tslint.json | [TSLint configuration](https://palantir.github.io/tslint/usage/tslint-json/) |
| tslint.build.json | [TSLint configuration (build only)](https://palantir.github.io/tslint/usage/tslint-json/) |
| README.md | The Markdown-based README generated for your application. |
| LICENSE | A copy of the MIT license. If you do not wish to use this license, please delete this file. |
| src/application.ts | The application class, which extends [`RestApplication`](http://apidocs.strongloop.com/@loopback%2frest/#RestApplication) by default. This is the root of your application, and is where your application will be configured. |
| src/index.ts | The starting point of your microservice. This file creates an instance of your application, runs the booter, then attempts to start the [`RestServer`](http://apidocs.strongloop.com/@loopback%2frest/#RestServer) instance bound to the application. |
| src/sequence.ts | An extension of the [Sequence](Sequence.md) class used to define the set of actions to take during a REST request/response. |
| src/controllers/README.md | Provides information about the controller directory, how to generate new controllers, and where to find more information. |
| src/controllers/ping.controller.ts | A basic controller that responds to GET requests at `/ping`. |
| src/datasources/README.md | Provides information about the datasources directory, how to generate new datasources, and where to find more information. |
| src/models/README.md | Provides information about the datasources directory, how to generate new datasources, and where to find more information. |
| src/repositories/README.md | Provides information about the repositories directory, how to generate new repositories, and where to find more information. |
| test/README.md | Please place your tests in this folder. |
| test/mocha.opts | [Mocha](https://mochajs.org/) configuration for running your application's tests. |
| test/acceptance/ping.controller.acceptance.ts | An example test to go with the ping controller in `src/controllers`. |
| File | Purpose |
| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| index.ts | Allows importing contents of the `src` folder (for use elsewhere) |
| index.js | Top-level wireup for execution of the application. |
| package.json | Your application's package manifest. See [package.json](https://docs.npmjs.com/files/package.json) for details. |
| tsconfig.json | The TypeScript project configuration. See [tsconfig.json](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for details. |
| tslint.json | [TSLint configuration](https://palantir.github.io/tslint/usage/tslint-json/) |
| tslint.build.json | [TSLint configuration (build only)](https://palantir.github.io/tslint/usage/tslint-json/) |
| README.md | The Markdown-based README generated for your application. |
| LICENSE | A copy of the MIT license. If you do not wish to use this license, please delete this file. |
| src/application.ts | The application class, which extends [`RestApplication`](http://apidocs.strongloop.com/@loopback%2frest/#RestApplication) by default. This is the root of your application, and is where your application will be configured. |
| src/index.ts | The starting point of your microservice. This file creates an instance of your application, runs the booter, then attempts to start the [`RestServer`](http://apidocs.strongloop.com/@loopback%2frest/#RestServer) instance bound to the application. |
| src/sequence.ts | An extension of the [Sequence](Sequence.md) class used to define the set of actions to take during a REST request/response. |
| src/controllers/README.md | Provides information about the controller directory, how to generate new controllers, and where to find more information. |
| src/controllers/ping.controller.ts | A basic controller that responds to GET requests at `/ping`. |
| src/datasources/README.md | Provides information about the datasources directory, how to generate new datasources, and where to find more information. |
| src/models/README.md | Provides information about the datasources directory, how to generate new datasources, and where to find more information. |
| src/repositories/README.md | Provides information about the repositories directory, how to generate new repositories, and where to find more information. |
| test/README.md | Please place your tests in this folder. |
| test/mocha.opts | [Mocha](https://mochajs.org/) configuration for running your application's tests. |
| test/acceptance/ping.controller.acceptance.ts | An example test to go with the ping controller in `src/controllers`. |

### Navigation

Expand Down

0 comments on commit dba531f

Please sign in to comment.