Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Commit 5c796ca

Browse files
author
Bowden Kelly
committed
port changes from PR #11
1 parent bb5281e commit 5c796ca

File tree

2 files changed

+2266
-1015
lines changed

2 files changed

+2266
-1015
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For other editors, make sure you have the corresponding [TypeScript plugin](http
4848

4949
## Project Structure
5050
The most obvious difference in a TypeScript + Node project is the folder structure.
51-
In a TypeScript project, you it's best to have separate _source_ and _distributable_ files.
51+
In a TypeScript project, it's best to have separate _source_ and _distributable_ files.
5252
TypeScript (`.ts`) files live in your `src` folder and after compilation are output as JavaScript (`.js`) in the `dist` folder.
5353
The `test` and `views` folders remain top level as expected.
5454

@@ -66,7 +66,7 @@ The full folder structure of this app is explained below:
6666
| **src/controllers** | Controllers define functions that respond to various http requests |
6767
| **src/models** | Models define Mongoose schemas that will be used in storing and retrieving data from MongoDB |
6868
| **src/public** | Static assets that will be used client side |
69-
| **src/types** | Holds .d.ts files not found on DefinitelyTyped. Covered more in this [section](#) |
69+
| **src/types** | Holds .d.ts files not found on DefinitelyTyped. Covered more in this [section](#type-definition-dts-files) |
7070
| **src**/server.ts | Entry point to your express app |
7171
| **test** | Contains your tests. Seperate from source because there is a different build process. |
7272
| **views** | Views define how your app renders on the client. In this case we're using pug |
@@ -291,7 +291,7 @@ This is mostly identical to the "Node.js: Launch Program" template with a couple
291291
| `"program": "${workspaceRoot}/dist/server.js",` | Modified to point to our entry point in `dist` |
292292
| `"smartStep": true,` | Won't step into code that doesn't have a source map |
293293
| `"outFiles": [...]` | Specify where output files are dropped. Use with source maps |
294-
| `"protocol": inspector,` | Use the new Node debug protocal because we're on the latest node|
294+
| `"protocol": inspector,` | Use the new Node debug protocol because we're on the latest node|
295295

296296
With this file in place, you can hit `F5` to serve the project with the debugger already attached.
297297
Now just set your breakpoints and go!
@@ -397,10 +397,10 @@ In that file you'll find two sections:
397397
| Package | Description |
398398
| ------------------------------- | --------------------------------------------------------------------- |
399399
| concurrently | Utility that manages multiple concurrent tasks. Used with npm scripts |
400-
| jest | Reports real-time server metrics for Express. |
401-
| node-sass | GitHub API library. |
400+
| jest | Testing library for JavaScript. |
401+
| node-sass | Allows to compile .scss files to .css |
402402
| supertest | HTTP assertion library. |
403-
| ts-test | Instagram API library. |
403+
| ts-test | A preprocessor with sourcemap support to help use TypeScript wit Jest.|
404404
| tslint | Linter (similar to ESLint) for TypeScript files |
405405
| typescript | JavaScript compiler/type checker that boosts JavaScript productivity |
406406

0 commit comments

Comments
 (0)