https://github.com/xjreb/skeleton-express-typescript

A skeleton project with Express.js, TypeScript, Mocha, and Chai.
https://github.com/xjreb/skeleton-express-typescript

chai expressjs mocha typescript

Last synced: 3 days ago
JSON representation

A skeleton project with Express.js, TypeScript, Mocha, and Chai.

• Host: GitHub
• URL: https://github.com/xjreb/skeleton-express-typescript
• Owner: xJREB
• Created: 2018-08-02T12:25:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T18:26:55.000Z (almost 2 years ago)
• Last Synced: 2023-03-01T12:25:41.602Z (almost 2 years ago)
• Topics: chai, expressjs, mocha, typescript
• Language: TypeScript
• Size: 392 KB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Expres.js Typescript RESTful API Skeleton Project

> A skeleton project for a RESTful web service with Express.js, TypeScript, Mocha, and Chai.

## Structure

- `src/index.ts`: entry file for the app that starts of express server

- `src/App.ts`: express app class where middleware is configured

- `src/routes/`: directory for all routes; all `*.routes.ts` files in here are automatically included by `index.ts` and injected into `App.ts`.

- `src/config/config.ts`: configuration file with app or environment specific properties

- `test/`: directory for all tests

## Build Setup

``` bash

# install dependencies

npm install

# serve locally with hot reload on localhost:3000 (adjustable in `src/config/config.ts` or with ENV variable `PORT`)

npm start

# build node.js version for production

npm run build

# start created production build

npm run prod

# run TypeScript linter

npm run lint

# run tests

npm test

```

## Useful VSCode Extensions

- TSLint (enforces coding rules in `tslint.json`)

- EditorConfig (enforces code formatting in `.editorconfig`)