Bun API Framework

A fast, lightweight REST API built with Bun, featuring a custom routing system, SQLite integration, file uploads, and a built-in logging system.

🚀 Features

• Fast Runtime: Powered by Bun for maximum performance.
• SQLite Database: Integrated SQLite support with a clean SQL tagging system.
• Custom Logger: Built-in middleware that logs requests to the console and app.log.
• File Uploads: Native file upload handling with automated local storage.
• Consistent Responses: Unified ApiResponse utility for structured JSON responses.
• Log Viewer: Dedicated endpoint to retrieve and parse system logs.

🛠 Installation

To install dependencies:

bun install

🚦 Getting Started

To run the server in development mode (with hot reloading):

bun run dev

To start the server:

bun start

The server will be running at http://localhost:3000.

📖 API Documentation

System

• GET /api/version: Returns the current API version.
• GET /api/logs: Returns parsed logs from app.log.

Users

• GET /api/v2/users: Get all users.
• POST /api/v2/create-user: Create a new user.
  • Body: { "name": "string", "email": "string" }
• DELETE /api/v2/delete-user/:id: Delete a user by ID.

Uploads

• POST /api/v2/upload: Upload a file (Multipart Form Data).
  • Field: file
• GET /api/v2/uploads/:filename: Serve an uploaded file.
• GET /api/v2/test: A test page for file uploads.

📁 Project Structure

src/
├── controllers/    # Request handlers
├── database/       # SQLite connection and schema
├── middlewares/    # Custom middlewares (logger, methods)
├── models/         # TypeScript interfaces
├── routes/         # Route definitions
├── utils/          # Helpers (Response, parseLog)
└── index.ts        # Entry point

📝 Logging

The API uses a custom logging middleware that records:

• Timestamp
• HTTP Method
• URL
• Status Code
• Duration (ms)
• Error Messages (if any)

Logs are saved to app.log in the root directory and can be accessed via the /api/logs endpoint.

---

Created with ❤️ using Bun v1.3.12