Skip to content

Latest commit

 

History

History
139 lines (107 loc) · 5.46 KB

README.md

File metadata and controls

139 lines (107 loc) · 5.46 KB
Raw
TypeScript Project Generator

NPM version GitHub license JavaScript Style Guide PRs Welcome Lint

This project has the goal to create a basic setup for a TypeScript project. It will create many files that are usually created manually. Currently the following files are being created:

  • .env
  • .eslintignore
  • .eslintrc
  • .gitignore
  • CHANGELOG.md
  • Dockerfile
  • heroku.yml (optional)
  • jest.config.ts (optional)
  • LICENSE (MIT as example)
  • nodemon.json
  • package.json
  • README.md
  • tsconfig.base.json
  • tsconfig.json

The following questions will be asked to the user:

  • Select your package manager:, npm, yarn and pnpm area available.
  • Project name:, at least one character must be provided.
  • Project description:, at least one character must be provided.
  • Author:, at least one character must be provided.
  • Email:, a correct email address must be provided.
  • Project version: the initial version of the project, 0.1.0 as default.
  • Select your license:, MIT, Unlicensed, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0, AGPL 3.0 are available.
  • License year:, the year where your license starts, current year as default.
  • Would you want to have a basic GitHub Action for the suit of tests and linting? [y/n].

What is new?

Please check the changelog.md file.

Project structure

📂.github
 ┣ 📂workflows
   ┣ 📜lint.yml
   ┗ 📜test.yml
📂src
 ┗ 📜index.ts
📂test
 ┗ 📜index.test.ts
📜.env
📜.eslintignore
📜.eslintrc
📜.gitignore
📜CHANGELOG.md
📜Dockerfile
📜heroku.yml
📜LICENSE
📜package.json
📜README.md
📜tsconfig.base.json
📜tsconfig.json
📜yarn.lock (or package-lock.json or pnpm-lock.yaml)

Finally, git will be initialized and a list of libraries will be installed. Check the notes.

Prerequisites

You need to have internet connection to install the packages and to get the license from this web page.

Installation

This project was intended to be installed globally, not locally, and also to initialize projects, be aware of that, you may broke something in your current working directory.

In order to install this package, run the following command in your terminal:

npm i -g typescript-project-generator

Usage

Once you have installed the package, please run the following command in your terminal:

tpg

This will guide you in a process to initialize your new project, asking you the questions shown above.

Notes

Here is the list of the packages that are being installed, as devDependencies:

Feel free to contribute to this project. Every contribution will be appreciated.

Hey, this project use to contain a backend generator!

Yes, it used to. But that approach has been deprecated in favor of my new backend framework, Simba.js.

Author

  • Anthony Luzquiños - Initial Work - Documentation - AnthonyLzq.

Contributors