generator-tsproject v1.0.4
generator-tsproject
A light, yet convenient, Yeoman generator for TypeScript + Node.JS projects
This generator will allows you to customize and scaffold your next TypeScript project in seconds.
Besides providing the basic files and packages needed for TypeScript + Node.js development, the generator will helps you to install and setup other usefull development tools such as Nodemon, or Jest.
:sparkles: NEW: You can now scaffold and customize a complete Express.JS project using yo tsproject:express
No more manual configuration required. š¤Æ
Psst ! It can also generate development Docker files and workflow files for Github Actions.
Getting started
npm install -g yo
npm install -g generator-tsproject
yo tsproject <project-name>
# Or for express projects :
yo tsproject:express <project-name>
Generated project's structure (tsproject
)
When all options are enabled, this is what a generated project looks like :
.
āāā Dockerfile
āāā docker-compose.yml
āāā jest.config.js
āāā node_modules/
ā āāā ...
āāā nodemon.json
āāā package.json
āāā readme.md
āāā src
ā āāā main.ts
āāā tests
ā āāā main.test.ts
āāā tsconfig.json
āāā yarn.lock
Generated project's structure (tsproject:express
)
With the express subgenerator, and all options enabled, this is what a generated project looks like :
.
āāā Dockerfile
āāā docker-compose.yml
āāā jest.config.js
āāā nodemon.json
āāā node_modules/
ā āāā ...
āāā package.json
āāā readme.md
āāā src
ā āāā errors
ā ā āāā http.error.ts
ā āāā index.ts
ā āāā middlewares
ā ā āāā demo.middleware.ts
ā āāā routes
ā ā āāā api.router.ts
ā ā āāā base.router.ts
ā ā āāā main.router.ts
ā āāā server.ts
ā āāā static
ā āāā views
ā āāā home.handlebars
ā āāā layouts
ā āāā main.handlebars
āāā tests
ā āāā express.test.ts
āāā tsconfig.json
āāā yarn.lock