https://github.com/dimaslz/nodejs-express-typescript

Basic setup to create apis with NodeJS + Express + TypeScript
https://github.com/dimaslz/nodejs-express-typescript

Last synced: 5 days ago
JSON representation

Basic setup to create apis with NodeJS + Express + TypeScript

• Host: GitHub
• URL: https://github.com/dimaslz/nodejs-express-typescript
• Owner: dimaslz
• Created: 2020-06-23T08:40:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-24T16:30:39.000Z (over 4 years ago)
• Last Synced: 2024-11-04T01:42:24.489Z (about 2 months ago)
• Language: TypeScript
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TypeScript Node Starter

My essential config to create REST API in NodeJS with TypeScript. Star, feedback and recommendation are welcome 🙂.

Based in [https://github.com/microsoft/TypeScript-Node-Starter](https://github.com/microsoft/TypeScript-Node-Starter). My idea is to create a example with some databases and common third party integrations.

If you need something similar, feel free to fork and join, I hope to help you!.

## Stack

* MongoDB

* Express

* TypeScript

## Scripts

| Npm Script | Description |

| ------------------------- | ------------------------------------------------------------------------------------------------- |

| `build`                   | Full build. Runs ALL build tasks (`build-sass`, `build-ts`, `lint`, `copy-static-assets`)         |

| `build-ts`                | Compiles all source `.ts` files to `.js` files in the `dist` folder                               |

| `debug`                   | Performs a full build and then serves the app in watch mode                                       |

| `lint`                    | Runs ESLint on project files                                                                      |

| `serve`                   | Runs node on `dist/server.js` which is the apps entry point                                       |

| `serve-debug`             | Runs the app with the --inspect flag                                                              |

| `start`                   | Does the same as 'npm run serve'. Can be invoked with `npm start`                                 |

| `test`                    | Runs tests using Jest test runner                                                                 |

| `watch`                   | Runs all watch tasks (TypeScript, Sass, Node). Use this if you're not touching static assets.     |

| `watch-debug`             | The same as `watch` but includes the --inspect flag so you can attach a debugger                  |

| `watch-node`              | Runs node with nodemon so the process restarts if it crashes. Used in the main watch task         |

| `watch-test`              | Runs tests in watch mode                                                                          |

| `watch-ts`                | Same as `build-ts` but continuously watches `.ts` files and re-compiles when needed               |

## TODO

- [ ] GraphQL demo and test

- [x] MongoDB demo and test

- [ ] SocketIO demo and test

- [ ] MySql demo and test

- [ ] PostgreSql demo and test

- [ ] Dockerfile

- [ ] Docker compose for Node and MongoDB

- [ ] Docker compose for Node and MySql

- [ ] Docker compose for Node and PostgreSql

## Author

Dimas López · FullStack Software development

🐦  [https://twitter.com/dimaslz](https://twitter.com/dimaslz)

👨🏻‍💻  [https://dimaslz.dev](https://dimaslz.dev)

📄  [https://www.linkedin.com/in/dimaslopezzurita](https://www.linkedin.com/in/dimaslopezzurita)