create-fastify-app
Advanced tools
Create Fastify App is an utility that help you to generate or add plugin to your Fastify project. This mean that you can easily:
If you want to use create-fastify-app you must first install globally on your machine
npm install -g create-fastify-app
Generate Fastify projects and utilities:
create-fastify-app [command] <options>
Command
generate:project Generate a ready to use Fastify project
generate:service Generate service skeleton source in given project
add:mongo Add MongoDB plugin in given project folder
add:mysql Add MySQL plugin in given project folder
add:cors Add CORS plugin in given project folder
add:redis Add Redis plugin in given project folder
Options
-d, --directory
Fastify project folder
-h, --help
Show this help message
Except for generate:project command the others work on an existent project created with create-fastify-app.
generate:projectGenerate a new Fastify project run following command
create-fastify-app generate:project -d <project-folder>
If -d, or --directory, option is omitted the new project will be created in curret folder. At this point further information will be asked:
After providing these information the entire application skeleton will be created for you. Simply run
cd /your/wonderful/application
npm install
npm run dev
By default create-fastify-app generate a project structured in this way:
/your/wonderful/application
├── README.md
├── app
│ ├── app.js
│ ├── plugins
│ │ ├── README.md
│ │ └── support.js
│ └── services
│ ├── README.md
│ ├── hello
│ │ └── index.js
│ └── root.js
├── args.js
├── help
│ └── start.txt
├── package.json
├── server.js
└── test
├── helper.js
├── plugins
│ └── support.test.js
└── services
├── example.test.js
└── root.test.js
The app folder contains all you need to develop your application. In particular, she contains the following directories:
plugins: here you can add all your plugins you need into you application.services: here you can develop all the endpoint you need for your application, or the generated endpoint if you give a swagger file at project creation.test: here you can declare all your test.The package.json file comes with three predefined npm task:
"scripts": {
"test": "tap test/**/*.test.js",
"start": "node server.js",
"dev": "node server.js -l info -P"
}
npm test: runs the testnpm start: start your applicationnpm run dev: start your application with pino-colada pretty loggingYou can pass the following options via command line with node server.js <options>. Every options has the corresponding environment variable:
| Description | Short command | Full command | Environment variable |
|---|---|---|---|
| The application file to start | -f | --file | FASTIFY_FILE |
| Port to listen on (default to 3000) | -p | --port | FASTIFY_PORT or PORT |
| Address to listen on | -a | --address | FASTIFY_ADDRESS |
| Log level (default to fatal) | -l | --log-level | FASTIFY_LOG_LEVEL |
| Prints pretty logs | -P | --pretty-logs | FASTIFY_PRETTY_LOGS |
| Use custom options | -o | --options | FASTIFY_OPTIONS |
| Set the prefix | -r | --prefix | FASTIFY_PREFIX |
| Set the plugin timeout | -T | --plugin-timeout | FASTIFY_PLUGIN_TIMEOUT |
| Defines the maximum payload, in bytes, the server is allowed to accept | --body-limit | FASTIFY_BODY_LIMIT |
When you generate a new project you can give in input a swagger file. In an api driven project this feature can be very important because create-fastify-app will generate all your project endpoints for you. You will only have to worry about the development of the various endpoints.
If you give in input the Petstore swagger file given as example on Swagger.io, you can see that create-fastify-app automatically generate a project with fastify-swagger already configured and ready to use in your project. If you take a look at /documentation endpoint you'll find something like that:
In your app/services folder you'll find your endpoints folder
./app/services
├── README.md
├── pet
│ ├── index.js
│ └── routes.schema.js
├── root.js
├── store
│ ├── index.js
│ └── routes.schema.js
└── user
├── index.js
└── routes.schema.js
generate:serviceThis command allow you to generate a new service skeleton for your api. You simply run
create-fastify-app generate:service -d <project-folder>
And give some information such as:
/api)Moreover the command generate for you a small set of test foreach methods.
add:mongoIf you want to easily add the fastify-mongodb plugin to your application this command is all you need. Just simply run
create-fastify-app add:mongo -d <project-folder>
And give some information such as:
At this point the command add the fastify-mongodb to you application with the given information for your MongoDB connection.
add:mysqlIf you want to easily add the fastify-mysql plugin to your application this command is all you need. Just simply run
create-fastify-app add:mysql -d <project-folder>
And give some information such as:
At this point the command add the fastify-mysql to you application with the given information for your MySQL connection.
add:redisIf you want to easily add the fastify-redis plugin just simply run
create-fastify-app add:redis -d <project-folder>
And give some information such as:
exactly as the add:mongo and add:mysql command add:redis add the plugin into your application plugins folder with the given information for your Redis connection.
add:corsIf you want to easily add the fastify-cors plugin just simply run
create-fastify-app add:cors -d <project-folder>
And give some information such as:
after the choises fastify-cors plugin will be added in your application.
If you feel you can help in any way, be it with examples, extra testing, or new features please open a pull request or open an issue.
The code follows the Standard code style.
It is inspired by the fastify-cli project. Some part have been extracted from it.
This project is kindly sponsored by Webeetle s.r.l.
Licensed under MIT.
FAQs
A Fastify application generator
The npm package create-fastify-app receives a total of 22 weekly downloads. As such, create-fastify-app popularity was classified as not popular.
We found that create-fastify-app demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.