https://github.com/mciccale/create-express-skel
A basic CLI tool to set-up a basic bolierplate for Express.js applications.
https://github.com/mciccale/create-express-skel
api boilerplate express generator javascript node scaffold typescript
Last synced: about 2 months ago
JSON representation
A basic CLI tool to set-up a basic bolierplate for Express.js applications.
- Host: GitHub
- URL: https://github.com/mciccale/create-express-skel
- Owner: mciccale
- License: mit
- Created: 2023-12-17T12:43:03.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T21:47:47.000Z (over 2 years ago)
- Last Synced: 2025-07-08T18:07:10.728Z (11 months ago)
- Topics: api, boilerplate, express, generator, javascript, node, scaffold, typescript
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-express-skel
`create-express-skel` is a command-line tool to quickly bootstrap a new Express.js application. It allows you to choose between a JavaScript or TypeScript setup and takes care of the initial boilerplate, including dependency installation and a basic project structure.
## Installation
This CLI tool is intended to be used with `npx`, so there's no need for a global installation. Make sure you have [Node.js](https://nodejs.org/) installed on your system.
## Usage
To create a new Express.js application, run:
```bash
npx create-express-skel
```
## Options
- ``: Specify the name of the project directly.
- `--ts`: Use this option if you want to create a TypeScript-based Express.js application.
- `--eslint`: Use this option if you want to install and configure ESlint in your Express.js application.
- `--no-eslint`: Use this option if you do not want to install and configure ESlint in your Express.js application.
- `--git`: Use this option if you want to initialize a Git repository.
- `--no-git`: Use this option if you do not want to initialize a Git repository.
If you do not provide a project name or options via the command line, `create-express-skel` will prompt you interactively to input these details.
## Interactive Mode
When running `create-express-skel` without any arguments, it enters an interactive mode, asking you for:
**Project Name**: The name of your new Express.js application.
**Template Type**: Whether you want your project in JavaScript or TypeScript.
**Configure ESlint**: Quickly install and configure ESlint.
**Initialize Git Repository**: Initialize the Git repository and initial commit.
## Example
Creating a new JavaScript Express.js application named 'my-app' and configure the project interactively:
```bash
npx create-express-skel my-app
```
Creating a new TypeScript Express.js application named 'my-app' and configure the project without interaction providing the necessary options:
```bash
npx create-express-skel my-app --ts --eslint --no-git
```
_Note_: If **ESlint** selected, its configuration runs intereactively
## Features
- Fast setup for new Express.js projects.
- Option to choose between JavaScript and TypeScript.
- Interactive mode for ease of use.
- Deals with all the boilerplate.
- Initializes a git repository with an initial commit.
## Contributing
Your contributions are always welcome! Please feel free to submit any issues or pull requests.
## License
Distributed under the MIT License. See `LICENSE` for more information.