Skip to content

mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

A command-line tool for creating new server projects using Fastify with SWC and Jest.

Note: This module requires SSH access to GitHub to clone this repository. If you do not already have SSH configured for GitHub, please follow the instructions on GitHub's Connecting to GitHub with SSH documentation to set up SSH keys for your account.

Install globally

npm i -g fastify-swc-typescript-server-bootstrap-cli

Usage

After installation, bootstrap a new Fastify SWC server project using the fastify-swc-server command:

fastify-swc-server [project-name]

Replace [project-name] with the intended name for the project. This creates a new directory with the specified name, clones the Fastify SWC server repo, and configures the project accordingly.

Current Features

  • Clones a boilerplate from this repository.
  • Removes the original .git directory and initializes a new git repository for a clean version control start.
  • Updates the package.json with the specified project name and resets the author value to an empty string.
  • More customizations to be added...

logo

Licensing

This project is licensed under the MIT License.

Third-Party Licenses

The repository uses some third-party dependencies under other licenses:

  • BSD-3-Clause
  • ISC

The full texts of these licenses are included in the repository.

Contributions and Issues

Contributions are welcome! If you have ideas for improvements, please open an issue first for discussion before submitting a pull request.

NOTE: The npm module's codebase uses a testing suite with Mocha and Chai, integrating Husky as a pre-commit git hook to ensure all tests pass before staged changes can be committed.

You can report issues or start discussions here: Open an issue

For contributions and issues regarding the codebase cloned with the fastify-swc-server command, open an issue here.