https://github.com/nirnejak/typescript-node-starter
A Node.js(Fastify) TypeScript Starter Template
https://github.com/nirnejak/typescript-node-starter
boilerplate boilerplate-template bunjs fastify nodejs starter starter-template template typescript
Last synced: 24 days ago
JSON representation
A Node.js(Fastify) TypeScript Starter Template
- Host: GitHub
- URL: https://github.com/nirnejak/typescript-node-starter
- Owner: nirnejak
- License: mit
- Created: 2021-05-19T08:48:45.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-21T17:37:47.000Z (26 days ago)
- Last Synced: 2025-04-23T22:07:59.335Z (24 days ago)
- Topics: boilerplate, boilerplate-template, bunjs, fastify, nodejs, starter, starter-template, template, typescript
- Language: TypeScript
- Homepage:
- Size: 1.77 MB
- Stars: 16
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typescript Node Starter
Node.js and Fastify project starter using TypeScript
> Note: Need to configure `.env` file to use local server
---
## Additional Packages Used
- drizzle - for database ORM
- colorette - for styling console output
- date-fns - for date operations and formatting
- heapdump - for getting dump of the current memory heap
---
## Available Scripts
**Install Dependencies**
```bash
bun install
```
**Setup Pre-commit**
```bash
bun run prepare
```
**Check ESLint issues**
```bash
bun run lint
```
**Format with Prettier**
```bash
bun run format
```
**Start Development Server**
```bash
bun run develop
```
**Create Migrations**
```bash
bun run db:generate
```
**Run Migrations**
```bash
bun run db:migrate
```
**Push Migration changes**
```bash
bun run db:push
```
**Build for Production**
```bash
bun run build
```
**Start Production Server**
```bash
bun start
```
---
## Docker Config
**Build Image**
```bash
docker build
```
**Run Image**
```bash
docker run -p 5000:5000
```
---
## Development Setup
- VS Code - Install the recommended extensions
- Volta - For managing node versions
## Guides
- [Best Practices](https://github.com/goldbergyoni/nodebestpractices)
---
## Next Steps
- API Doc - [Swagger](https://swagger.io/)
- GraphQL - [Mercurius](https://mercurius.dev/)
- Web Socket - [Socket.io](https://socket.io/)
- Background Worker - [BullMQ](https://docs.bullmq.io/)