https://github.com/locnguyen/typescript-node-starter

Barebones starter kit for server apps with TypeScript
https://github.com/locnguyen/typescript-node-starter

api docker nodejs typescript

Last synced: over 1 year ago
JSON representation

Barebones starter kit for server apps with TypeScript

• Host: GitHub
• URL: https://github.com/locnguyen/typescript-node-starter
• Owner: locnguyen
• License: mit
• Created: 2017-01-07T01:54:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-01T03:52:08.000Z (over 3 years ago)
• Last Synced: 2024-04-14T19:25:37.580Z (about 2 years ago)
• Topics: api, docker, nodejs, typescript
• Language: Makefile
• Size: 1.09 MB
• Stars: 18
• Watchers: 3
• Forks: 3
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# typescript-node-starter

| GitLab CI |

| - |

| [![pipeline status](https://gitlab.com/lochnguyen/typescript-node-starter/badges/master/pipeline.svg)](https://gitlab.com/lochnguyen/typescript-node-starter/commits/master) |

Barebones starter kit for server apps with TypeScript

## Quick Start

Install Node dependencies

```shell

$ npm install

```

Run the test suite

```shell

$ npm t

```

Run the code for development and watch for changes

```shell

$ npm run dev

```

Compile the code for release

```shell

$ npm run build

```

Run the compiled code

```shell

$ node -r ./bootstrap.js build

```

## Docker

If you want to develop in a Docker container, this project along with PostgreSQL can be brought up with

```shell

make up

```

And when you are done working

```shell

make down

```

See the **docker-compose.yml** file for details on this set up.

### Production Image

```shell

docker build --target release -t tsnodestarter:$(git rev-parse --short=7 HEAD) .

```