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

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

fastify fastify-tool nodejs npx

Last synced: about 2 months 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 (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T17:30:58.000Z (4 months ago)
• Last Synced: 2024-07-28T00:35:14.015Z (about 2 months ago)
• Topics: fastify, fastify-tool, nodejs, npx
• Language: JavaScript
• Homepage:
• Size: 51.8 KB
• Stars: 97
• Watchers: 14
• Forks: 8
• 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/workflows/CI/badge.svg)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)

> 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.

The code follows the Standard code style.

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

## License

**[MIT](https://github.com/fastify/fastify-cli/blob/master/LICENSE)**

*The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.*