https://github.com/timothymiller/typescript-microservice

🐳 TypeScript microservice on Docker with optimized defaults
https://github.com/timothymiller/typescript-microservice

bundling docker eslint nodejs npm pm2 prettier rollup typescript visual-studio-code yarn

Last synced: about 1 month ago
JSON representation

🐳 TypeScript microservice on Docker with optimized defaults

• Host: GitHub
• URL: https://github.com/timothymiller/typescript-microservice
• Owner: timothymiller
• License: gpl-3.0
• Created: 2019-12-21T08:25:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-02T00:38:50.000Z (over 3 years ago)
• Last Synced: 2024-05-02T03:11:01.282Z (8 months ago)
• Topics: bundling, docker, eslint, nodejs, npm, pm2, prettier, rollup, typescript, visual-studio-code, yarn
• Language: Dockerfile
• Homepage: https://timknowsbest.com/dockerized-typescript-app-template
• Size: 141 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🐬 TypeScript Microservice

TypeScript Microservice starter project with batteries included.

## 🔔 Features

- Code in ES6 TypeScript

- ESLint & Prettier integration with VS Code extensions

- Instant code reload in debug mode

- JavaScript optimizations

## 🔩 Code Quality

- ESLint - Airbnb JavaScript Style Guide

- Prettier - Format code on save

## 💨 JavaScript Optimizations

- [Rollup](https://www.npmjs.com/package/rollup)

- Tree-shaking

- Optimize ES modules for faster native loading

- Removes `console.log` statements from docker builds

- CommonJS module format

## 🔨 Unit Testing

- Mocha

- Chai

## 🎬 Getting Started

```yarn start```

Execute source code with nodemon for live reloading of code changes.

```yarn test```

Run all *.test.ts files in test/ directory.

```yarn build```

Export app to prod/app.ts after running tsc & rollup.

## 🛥️ External Ports

If you wanted to extend this template to create an API server, you would do so in your docker-compose file utilizing the output image from this template or when running from the command line like this:

```docker run -p : -d ```

## License

This Template is licensed under the GNU General Public License, version 3 (GPLv3).

## Author

Timothy Miller

[View my GitHub profile 💡](https://github.com/timothymiller)

[View my personal website 💻](https://timknowsbest.com)