https://github.com/cudi7/easy-peasy-express-sequeezy

Basic starter for a Node.js/Express.js API with TypeScript, Jest, Supertest, Zod, MongoDB
https://github.com/cudi7/easy-peasy-express-sequeezy

cors dotenv eslint express helmet jest mongodb morgan nodejs nodemon supertest ts-node typescript zod

Last synced: 30 days ago
JSON representation

Basic starter for a Node.js/Express.js API with TypeScript, Jest, Supertest, Zod, MongoDB

• Host: GitHub
• URL: https://github.com/cudi7/easy-peasy-express-sequeezy
• Owner: Cudi7
• License: mit
• Created: 2023-02-16T14:40:11.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-16T14:42:09.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T16:20:54.172Z (3 months ago)
• Topics: cors, dotenv, eslint, express, helmet, jest, mongodb, morgan, nodejs, nodemon, supertest, ts-node, typescript, zod
• Language: TypeScript
• Homepage:
• Size: 73.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express API Starter with Typescript

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/mocha)

  - 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

```

## Variables

```

Create you .env file with the following variables

MONGO_URI=mongodb+srv://**********

(https://www.mongodb.com/atlas)

PORT=5001

```

## Lint

```

npm run lint

```

## Test

```

npm run test

```

## Development

```

npm run dev

```