Gathering detailed insights and metrics for create-tsc-server
A CLI tool to quickly set up a TypeScript Node.js Express server with built-in features for modular development, authentication, and MongoDB integration.
Installations
npm install create-tsc-serverDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
20.16.0
NPM Version
10.8.1
Score
65.5
Supply Chain
97.9
Quality
81.6
Maintenance
100
Vulnerability
100
License
Contributors
1
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
979
Last Day
1
Last Week
11
Last Month
51
Last Year
979
GitHub Statistics
MIT License
7 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Aug 27, 2024
Bundle Size
127.45 kB
Minified
40.19 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
2.0.4
Package Id
create-tsc-server@2.0.4
Unpacked Size
11.18 kB
Size
4.41 kB
File Count
6
NPM Version
10.8.1
Node Version
20.16.0
Published on
Aug 27, 2024
Total Downloads
Cumulative downloads
Total Downloads
979
Last Day
-50%
1
Compared to previous day
Last Week
-52.2%
11
Compared to previous week
Last Month
112.5%
51
Compared to previous month
Last Year
0%
979
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Create TypeScript Boilerplate Server
create-tsc-server is a command-line tool that helps you quickly create a boilerplate TypeScript server by cloning a predefined GitHub repository.
Features
- 🚀 Quick Setup: Instantly clone a TypeScript server template and get started.
- 💡 Easy to Use: Simple command to create a new server project.
- 📦 Production and Development Scripts: Scripts to start the server in production and development modes.
- 🛠️ Build Script: Compile TypeScript code to JavaScript.
- 🧹 Linting and Formatting: ESLint and Prettier configurations for code quality.
- 🔐 Security: Built-in support for JWT authentication and bcrypt for password hashing.
- 🌐 Middleware: Includes cookie-parser, CORS, and dotenv for environment variables.
- 📦 Database: Mongoose integration for MongoDB.
- 📂 builtin module create:Automatically create import module files.
Update
Creating a New Module
To create a new module within your existing TypeScript server project, use the following command:
1npx tsc-module <module-name>
This command will:
-
Create a new directory named
<module-name>inside thesrc/modulesdirectory. -
Generate the following files inside the new directory:
-
<module-name>.constant.ts -
<module-name>.controller.ts -
<module-name>.interface.ts -
<module-name>.model.ts -
<module-name>.route.ts -
<module-name>.service.ts -
<module-name>.utils.ts -
<module-name>.validation.tsEach file will contain a basic template to get you started quickly.
-
Example
1npx tsc-module user
This will create the following structure inside src/modules:
- User/
- user.constant.ts
- user.controller.ts
- user.interface.ts
- user.model.ts
- user.route.ts
- user.service.ts
- user.utils.ts
- user.validation.ts
Installation
You can install create-tsc-server globally using npm:
1npm install -g create-tsc-server
Or use it directly with npx (no installation required):
1npx create-tsc-server <app-name>
Usage
To create a new TypeScript server project, run:
1npx create-tsc-server my-app
Replace my-app with your desired project name.
This will:
- Clone the boilerplate repository.
- Create a new directory named awesome-server.
- Remove the .git directory from the cloned repository.
- Set up your new TypeScript server project.
Boilerplate Repository
The tool clones the repository from GitHub.
Project Structure
The generated project includes:
📦 src
├─ app
│ ├─ builder
│ ├─ config
│ ├─ DB
│ ├─ errors
│ │ ├─ AppError.ts
│ │ ├─ handleCastError.ts
│ │ ├─ handleDuplicateError.ts
│ │ ├─ handleValidationError.ts
│ │ └─ handleZodError.ts
│ ├─ helpers
│ ├─ interface
│ │ ├─ error.ts
│ │ └─ index.d.ts
│ ├─ middlewares
│ │ ├─ authGaurd.ts
│ │ ├─ globalErrorHandler.ts
│ │ ├─ notFoundAPIHandler.ts
│ │ └─ validateRequest.ts
│ ├─ routes
modules
│ │ └─ ExampleMoudles
│ │ ├─ user.constant.ts
│ │ ├─ user.controller.ts
│ │ ├─ user.interface.ts
│ │ ├─ user.model.ts
│ │ ├─ user.route.ts
│ │ ├─ user.service.ts
│ │ ├─ user.utils.ts
│ │ └─ user.validation.ts
│ ├─ shared
│ └─ utils
│ ├─ catchAsync.ts
│ └─ sendResponse.ts
├─ server.t
├─ app.ts
├─ tsconfig.json
├─ .env.example
├─ .prettierrc.json
├─ eslint.config.mjs
└─ yarn.lock
©generated by Project Tree Generator
Scripts
The package.json includes several useful scripts:
- Start in Production:
yarn start:prod- Runs the server using the compiled JavaScript files.
- Start in Development:
yarn start:dev- Runs the server using ts-node-dev with automatic restarts and TypeScript transpilation.
- Build:
yarn build- Compiles TypeScript code to JavaScript.
- Lint:
yarn lint- Runs ESLint on the src directory.
- Lint Fix:
yarn lint:fix- Automatically fixes ESLint issues in the src directory.
- Prettier:
yarn prettier- Formats the code using Prettier.
- Prettier Fix:
yarn prettier:fix- Automatically formats the code in the src directory.
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any bugs, improvements, or features you'd like to see.
- Fork the repository.
- Create a new branch (git checkout -b feature-branch).
- Make your changes.
- Commit your changes (git commit -am 'Add new feature').
- Push to the branch (git push origin feature-branch).
- Open a Pull Request.
Dependencies
Production
- @typescript-eslint/eslint-plugin
- @typescript-eslint/parser
- bcrypt
- cookie-parser
- cors
- dotenv
- eslint
- express
- http-status
- jsonwebtoken
- mongoose
- zod
Development
- @eslint/js
- @types/bcrypt
- @types/cookie-parser
- @types/cors
- @types/express
- @types/jsonwebtoken
- @types/node
- eslint-config-prettier
- globals
- prettier
- ts-node
- ts-node-dev
- typescript
- typescript-eslint
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
For any questions or feedback, feel free to reach out via GitHub Issues.
Made with ❤️ by MD. Monir Hoshen, GitHub Profile
tsc-server-npm
No vulnerabilities found.
No security vulnerabilities found.