https://github.com/rjmacarthy/express-typescript-starter

An Express.js project implemented using Typescript with strongly typed objects.
https://github.com/rjmacarthy/express-typescript-starter

express-js mocha-chai mongodb socket-io typescript

Last synced: about 12 hours ago
JSON representation

An Express.js project implemented using Typescript with strongly typed objects.

• Host: GitHub
• URL: https://github.com/rjmacarthy/express-typescript-starter
• Owner: rjmacarthy
• License: mit
• Created: 2016-04-07T17:59:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T11:32:03.000Z (12 months ago)
• Last Synced: 2024-10-29T23:14:54.632Z (14 days ago)
• Topics: express-js, mocha-chai, mongodb, socket-io, typescript
• Language: TypeScript
• Homepage:
• Size: 1.21 MB
• Stars: 195
• Watchers: 11
• Forks: 51
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Typescript and Express.js 

=========================

![Build Status](https://github.com/rjmacarthy/express-typescript-starter/actions/workflows/main.yml/badge.svg)

An Express.js project implemented using Typescript with strongly typed objects:

# Installation

Clone the repository

```

npm install 

```

For development:

```

npm run dev

```

To start:

```

npm run start

```

To debug in visual studio code:

```

npm run debug

```

Then run the `launch.json` configuration inside visual studio code `f5`.  You should now be able to set breakpoints in your typescript.

Test

```

npm run test

```

Test Watch

```

npm run test:watch

```

Build to `./dist`

```

npm run build

```

Browse to http://localhost:3000

# Folder structure

```

├── docker-compose.yaml

├── Dockerfile

├── nodemon.json

├── package.json

├── package-lock.json

├── README.md

├── spec

│   ├── index.spec.ts

│   └── model.spec.ts

├── src

│   ├── controllers

│   │   └── index.server.controller.ts

│   ├── database

│   │   └── index.ts

│   ├── helpers

│   │   └── index.ts

│   ├── index.ts

│   ├── models

│   │   └── example.model.ts

│   ├── public

│   │   ├── favicon.ico

│   │   └── stylesheets

│   ├── routes

│   │   └── index.server.route.ts

│   ├── server

│   │   └── index.ts

│   ├── socket

│   │   └── index.ts

│   ├── tsconfig.json

│   ├── var

│   │   └── config.ts

│   └── views

│       ├── error.pug

│       ├── index.pug

│       └── layout.pug

├── tsconfig.json

└── tslint.json

```

# Docker

Build the image `docker build -t rjmacarthy/express-typescript-starter .`

Run the image `docker-compose up`

Open `http://localhost:3000`

# License

MIT