https://github.com/vwh/vwnode
Quick starter template for your Node.js project includes Bun, Biomejs, Typescript and more
https://github.com/vwh/vwnode
biomejs bun docker node-template production public-template template testing tsup typescript
Last synced: 6 months ago
JSON representation
Quick starter template for your Node.js project includes Bun, Biomejs, Typescript and more
- Host: GitHub
- URL: https://github.com/vwh/vwnode
- Owner: vwh
- Created: 2024-09-04T05:07:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-28T06:15:17.000Z (about 1 year ago)
- Last Synced: 2025-03-27T17:51:39.982Z (7 months ago)
- Topics: biomejs, bun, docker, node-template, production, public-template, template, testing, tsup, typescript
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
VwNode
QuickStarter for Node.js: A streamlined setup to kickstart your Node.js projects with TypeScript, Biome for linting and formatting, and support for both npm and Bun. Enhance your development workflow with efficiency and flexibility.
## 🗃️ Project Structure
```bash
vw-node/
├── biome.json # Biome configuration
├── bun.lockb # Bun lockfile
├── Dockerfile # Docker configuration
├── package.json # Project metadata and dependencies
├── package-lock.json # npm lockfile
├── README.md # Project documentation
├── src/ # Source files
│ └── index.ts # Main TypeScript file
├── tests/ # Test files
├── tsconfig.json # TypeScript configuration
└── tsup.config.ts # tsup configuration
```
## 🚀 Getting Started
### 📥 Installation
Clone the repository and install dependencies:
```bash
git clone https://github.com/vwh/vwnode
cd vwnode
# Using bun
bun install
# Or using npm
npm install
```
### 💻 Development Server
Start the development server:
```bash
# Using Bun
bun run dev
# Or using npm
npm run dev
```
### 🏗️ Build
Build the project for production:
```bash
# Using Bun
bun run build
# Or using npm
npm run build
```
### 🚀 Start
Run the production build:
```bash
# Using Bun
bun run start
# Or using npm
npm run start
```
### 🧹 Linting
Lint the project files:
```bash
# Using Bun
bun run lint
# Or using npm
npm run lint
```
### 🎨 Formatting
Format the project files:
```bash
# Using Bun
bun run format
# Or using npm
npm run format
```
Check the formatting:
```bash
# Using Bun
bun run format:check
# Or using npm
npm run format:check
```
### 🧐 Type Check
```bash
# Using Bun
bun run type-check
# Or using npm
npm run type-check
```
### 🐳 Docker
Build the Docker image:
```bash
# Using Bun
bun run docker:build
# Or using npm
npm run docker:build
```
Run the Docker image:
```bash
# Using Bun
bun run docker:run
# Or using npm
npm run docker:run
```
## 🤝 Contributing
Contributions are welcome! Feel free to open a pull request with your improvements or fixes.