https://github.com/ljlm0402/typescript-fastify-starter

🚀 TypeScript Fastify Starter
https://github.com/ljlm0402/typescript-fastify-starter

fastify nodejs npm typescript

Last synced: 2 months ago
JSON representation

🚀 TypeScript Fastify Starter

• Host: GitHub
• URL: https://github.com/ljlm0402/typescript-fastify-starter
• Owner: ljlm0402
• License: mit
• Created: 2020-02-11T11:46:08.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-04T01:29:52.000Z (almost 5 years ago)
• Last Synced: 2024-09-17T01:23:50.147Z (3 months ago)
• Topics: fastify, nodejs, npm, typescript
• Language: JavaScript
• Homepage: http://npm.im/typescript-fastify-starter
• Size: 145 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[Fastify](https://www.fastify.io/) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.










## 🧐 What is it?

Creates a new typescript fastify application.

application is configured to use TypeScript instead of plain JavaScript. 

## 🤔 Why typescript-fastify-starter?

Node Js is great for the rapid development of web-projects, but is often neglected because of the lack of

type safety. TypeScript solves this issue and (along with its linter file) can even make your code

more robust than some other static languages like Java.

## ⚙️ Installation

```sh

$ npm install -g typescript-fastify-starter

```

## 🚀 Quick Start

The quickest way to get started is use npx and pass in the name of the project you want to create.

If you don't specify a project name, the default _typescript-fastify-starter_ will be used instead.

### 1. Create the app

```bash

$ npx typescript-fastify-starter "project name"

```

Choose the template you want. We will create more templates later.

Start your typescript-fastify-starter app in development mode at `http://localhost:3000/`

```bash

$ cd "project name" && npm run start

```

## 🎠 Available commands for the server.

- Run the Server in production mode : `npm run start`.

- Run the Server in development mode : `npm run dev`.

- Run all unit-tests: `npm run test`.

- Check for linting errors: `npm run lint`.

You may need to install [nodemon](https://www.npmjs.com/package/nodemon) separately if you do not currently have it installed on your machine.

## ⛑ Code Structure (default)

```bash

│

├── /src

│   ├── /routes

│   │   └── index.route.ts

│   │

│   ├── /test

│   │   └── index.test.ts

│   │

│   ├── app.ts

│   └── server.ts

│

├── .gitignore

├── jest.config.js

├── package-lock.json

├── package.json

└── tsconfig.json

```

## 💳 License

[MIT](LICENSE)

## 🤝 Contributors