create-sprive-starter
v1.2.4
Published
Hey! Welcome to our cli tool that streamlines creating a new node application.
Downloads
222
Readme
Create sprive starter
Hey! Welcome to our cli tool that streamlines creating a new node application.
Creating a new app
To create a new app:
npx create-sprive-starter [project-directory] [options]
If not already specified, you will be asked for the name of your app:
? What would you like to name the project? › my-app
And then what project template you would like to create
? What project template would you like to create?
> node (default)
> fastify
You can also use the tool non-interactively:
create-sprive-starter [project-directory] --template [template]
Here are the available options:
Usage: create-sprive-starter [project-directory] [options]
Arguments:
project-directory
the directory to create the project in.
Options:
--template [template] Specify the project template (choices: "node", "fastify")
-h, --help display help for command
Template
When creating a new app, you will be prompted to choose your template. You can choose between fastify
or the node (default)
template.
When you want to create a Fastify
service, choose fastify
. If you want to create a node library, choose node
.
Features
Upon creating a new project, a node application with the app name/directory you specify will be created. It comes with features like:
- common dependencies installed (typescript-eslint, vitest)
- testing and linting pre-commit hooks (with husky and lint-staged)
- git commit message linting with commitlint
- prettier
Commonly used NPM scripts
# run tests, coverage report, vitest-ui
npm run test
npm run coverage
npm run test-ui
# run linter
npm run lint
# run formatter
npm run format