https://github.com/fastify/create-fastify

Rapidly generate a Fastify project
https://github.com/fastify/create-fastify

fastify fastify-tool nodejs npx

Last synced: 3 days ago
JSON representation

Rapidly generate a Fastify project

• Host: GitHub
• URL: https://github.com/fastify/create-fastify
• Owner: fastify
• License: mit
• Created: 2020-03-04T11:54:07.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-16T01:11:14.000Z (16 days ago)
• Last Synced: 2025-01-22T06:01:39.333Z (10 days ago)
• Topics: fastify, fastify-tool, nodejs, npx
• Language: JavaScript
• Homepage: https://npmjs.com/package/create-fastify
• Size: 70.3 KB
• Stars: 126
• Watchers: 14
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-fastify

[![CI](https://github.com/fastify/create-fastify/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/create-fastify/actions/workflows/ci.yml)

[![NPM version](https://img.shields.io/npm/v/create-fastify.svg?style=flat)](https://www.npmjs.com/package/create-fastify)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

> Rapidly generate a Fastify project

## Usage

There is no need to install this package directly.

```sh

npm init fastify [your_app_name]

```

The `npm init` command will find this package automatically and run it.

### Integrate

To integrate Fastify into an existing project:

```sh

npm init fastify --integrate

```

Note that this will overwrite files, so exercise caution.

Files and folders that will be overwritten by integrate mode:

* .gitignore

* app.js

* plugins

* routes

* test

The `package.json` file will not be overwritten but will be modified.

The plugins are loaded with [@fastify/autoload](https://github.com/fastify/fastify-autoload) with an empty default configuration.

## Contributing

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.

## License

Licensed under [MIT](./LICENSE).