TSProGen
TSProGen is a CLI tool to generate a basic file structure for a TypeScript-Node project.
Live Version
This page is not yet deployed.
Installing the Tool
Run the following command in your terminal to install the CLI tool:
npm install -g tsprogen
Running the Tool
With your terminal pointed at your root project directory (where you want the files generated), use this command:
tsprogen
This will generate the initial file structure for your project.
Testing Your New Project
To test your new project, you will need to build and start the script. If you do not have TypeScript installed globally, run npm install typescript
. Then use the following script to build the files:
npm run build
To run the server, use:
npm run start
You should see "index.ts works!" in your console - congratulations! Your project is ready for development!
Feedback and Bugs
If you have feedback or a bug report, please feel free to open a GitHub issue!
Contributing
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our contributing guidelines first.
Code of Conduct
Before interacting with our community, please read our Code of Conduct.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!