Giter VIP home page Giter VIP logo

express-typescript-template-generator's Introduction

Welcome to Express with typescript and good practices template ๐Ÿ‘‹

License: ISC

Base express.js template with TypeScript and best practices ready for start to coding.

Feactures

  • Typescript
  • Dodumentation with jsdoc (available in jsdoc/docs/index.html)
  • Commits convections
  • Eslint
  • Repository pattern
  • DTO pattern
  • Validation middlwares
  • Error handler
  • Mogoose config
  • Dotenv config
  • Testing with jest
  • Pretty logs with winston
  • Pretty routes pattern

Installation

npm i -g express-typescript-template-generator

Use

express-typescript-template-generator
cd <project-name>

Configure your .env file with the necessary environment variables. Create the .env and .env.dev files at the root of the project with:

  • DB_URI=your database uri

Development usage

npm run tsc
npm run dev

Open the browser in: http://localhost:3000/api/example.

Production usage

npm start

Run tests

npm run test

Create documentation

npm run jsdoc

Eslint

npm run lint
npm run lint:fix

Author

๐Ÿ‘ค Deiver Carrascal

Show your support

Give a โญ๏ธ if this project helped you!. Can make pull request to contribute!.


This README was generated with โค๏ธ by readme-md-generator

express-typescript-template-generator's People

Contributors

ingdeiver avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.