https://github.com/w3cj/express-api-starter-ts

A basic starter for an express.js API with Typescript
https://github.com/w3cj/express-api-starter-ts

Last synced: 5 days ago
JSON representation

A basic starter for an express.js API with Typescript

• Host: GitHub
• URL: https://github.com/w3cj/express-api-starter-ts
• Owner: w3cj
• License: mit
• Created: 2022-08-18T05:19:03.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T12:14:06.000Z (about 1 month ago)
• Last Synced: 2024-11-07T01:48:44.788Z (5 days ago)
• Language: TypeScript
• Size: 416 KB
• Stars: 382
• Watchers: 2
• Forks: 121
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express API Starter with Typescript

How to use this template:

```sh

npx create-express-api --typescript --directory my-api-name

```

Includes API Server utilities:

* [morgan](https://www.npmjs.com/package/morgan)

  * HTTP request logger middleware for node.js

* [helmet](https://www.npmjs.com/package/helmet)

  * Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!

* [dotenv](https://www.npmjs.com/package/dotenv)

  * Dotenv is a zero-dependency module that loads environment variables from a `.env` file into `process.env`

* [cors](https://www.npmjs.com/package/cors)

  * CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.

Development utilities:

* [typescript](https://www.npmjs.com/package/typescript)

  * TypeScript is a language for application-scale JavaScript.

* [ts-node](https://www.npmjs.com/package/ts-node)

  * TypeScript execution and REPL for node.js, with source map and native ESM support.

* [nodemon](https://www.npmjs.com/package/nodemon)

  * nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.

* [eslint](https://www.npmjs.com/package/eslint)

  * ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.

* [typescript-eslint](https://typescript-eslint.io/)

  * Tooling which enables ESLint to support TypeScript.

* [jest](https://www.npmjs.com/package/jest)

  * Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

* [supertest](https://www.npmjs.com/package/supertest)

  * HTTP assertions made easy via superagent.

## Setup

```

npm install

```

## Lint

```

npm run lint

```

## Test

```

npm run test

```

## Development

```

npm run dev

```