Skip to content

Commit

Permalink
fix(docs): add missing backtick to table
Browse files Browse the repository at this point in the history
  • Loading branch information
@nabdelgadir
nabdelgadir committed Mar 13, 2019
1 parent 05ee84d commit 2797153
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions docs/site/todo-tutorial-scaffolding.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,6 @@ src/
index.ts
migrate.ts
sequence.ts
test/
mocha.opts
node_modules/
***
LICENSE
Expand All @@ -83,27 +81,27 @@ tslint.json
.mocharc.json
```

| File | Purpose |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `index.ts` | Allows importing contents of the `src` folder (for use elsewhere) |
| `index.js` | Top-level file connecting components 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%2fdocs/rest.html#RestApplication) by default. This is the root of your application, and is where your application will be configured. It also extends [`RepositoryMixin`](https://apidocs.strongloop.com/@loopback%2fdocs/repository.html#RepositoryMixin) which defines the datasource. |
| `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%2fdocs/rest.html#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 models directory, how to generate new models, 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. |
| `src/__tests__/README.md` | Please place your tests in this folder. |
| `src/__tests__/acceptance/ping.controller.acceptance.ts` | An example test to go with the ping controller in `src/controllers`. |
| `.mocharc.json` | [Mocha](https://mochajs.org/) configuration for running your application's tests. |
| File | Purpose |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `index.ts` | Allows importing contents of the `src` folder (for use elsewhere) |
| `index.js` | Top-level file connecting components 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%2fdocs/rest.html#RestApplication) by default. This is the root of your application, and is where your application will be configured. It also extends [`RepositoryMixin`](https://apidocs.strongloop.com/@loopback%2fdocs/repository.html#RepositoryMixin) which defines the datasource. |
| `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%2fdocs/rest.html#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 models directory, how to generate new models, 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. |
| `src/__tests__/README.md` | Please place your tests in this folder. |
| `src/__tests__/acceptance/ping.controller.acceptance.ts` | An example test to go with the ping controller in `src/controllers`. |
| `.mocharc.json` | [Mocha](https://mochajs.org/) configuration for running your application's tests. |

### Navigation

Expand Down

0 comments on commit 2797153

Please sign in to comment.