https://github.com/aashari/boilerplate-rest-api-bun
This repository contains a boilerplate for building a REST API using the Bun runtime, an alternative to Node.js designed to be faster and more efficient. The project is structured using Elysia, a minimalist web framework for Bun, and mongoose for MongoDB object modeling.
https://github.com/aashari/boilerplate-rest-api-bun
api boilerplate bun docker elysia elysiajs mongodb mongoose rest-api typescript
Last synced: 7 months ago
JSON representation
This repository contains a boilerplate for building a REST API using the Bun runtime, an alternative to Node.js designed to be faster and more efficient. The project is structured using Elysia, a minimalist web framework for Bun, and mongoose for MongoDB object modeling.
- Host: GitHub
- URL: https://github.com/aashari/boilerplate-rest-api-bun
- Owner: aashari
- Created: 2024-01-04T05:20:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T03:27:16.000Z (7 months ago)
- Last Synced: 2025-03-01T04:20:49.623Z (7 months ago)
- Topics: api, boilerplate, bun, docker, elysia, elysiajs, mongodb, mongoose, rest-api, typescript
- Language: TypeScript
- Homepage: https://aashari.github.io/boilerplate-rest-api-bun
- Size: 20.5 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boilerplate REST API using Bun
This repository contains a beginner-friendly boilerplate for building a REST API using the [Bun](https://bun.sh/) runtime,
an alternative to Node.js designed to be faster and more efficient. The project is structured using `Elysia`,
a minimalist web framework for Bun, and `mongoose` for MongoDB object modeling.
## Features
- **Bun Runtime**: Ultra-fast JavaScript runtime as an alternative to Node.js
- **Elysia Framework**: Lightweight and fast web framework for handling HTTP requests
- **MongoDB Integration**: Complete setup with Mongoose models for authors and posts
- **Docker Support**: Ready-to-use Docker Compose setup for MongoDB and Mongo Express
- **TypeScript**: Full TypeScript support for better developer experience
- **Error Handling**: Built-in middleware for error handling and response standardization
- **Environment Variables**: Configured to use environment variables for easy configuration
- **Helper Scripts**: Includes a convenient script for managing the API and MongoDB
- **Detailed Guide**: Comprehensive guide for running and testing the API
## Prerequisites
- [Bun](https://bun.sh/) installed on your system
- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) (optional, for running MongoDB)
## Quick Start
### Step 1: Clone the repository
```sh
git clone https://github.com/aashari/boilerplate-rest-api-bun.git
cd boilerplate-rest-api-bun
```
### Step 2: Set up environment variables
```sh
# Copy the example environment file
cp .env.example .env
```
### Step 3: Start MongoDB using Docker Compose
```sh
# Start MongoDB and Mongo Express
./api.sh mongo-up
# You can access Mongo Express at http://localhost:8081
```
### Step 4: Install dependencies
```sh
bun install
```
### Step 5: Start the development server
```sh
# Start the API in the background
./api.sh start
# Check the logs
./api.sh logs
```
The server will start at http://localhost:3000 by default.
## Using the Helper Script
This project includes a helper script (`api.sh`) to make it easier to manage the API and MongoDB:
```sh
# Show available commands
./api.sh help
# Start the API
./api.sh start
# Check if the API is running
./api.sh status
# View API logs
./api.sh logs
# Stop the API
./api.sh stop
# Start MongoDB containers
./api.sh mongo-up
# Stop MongoDB containers
./api.sh mongo-down
```
## Detailed Guide
For a comprehensive guide on running and testing the API, see the [GUIDE.md](GUIDE.md) file.
## API Endpoints
### Posts
- `GET /posts` - Get all posts
- `POST /posts` - Create a new post
- `GET /posts/:id` - Get a post by ID
- `PUT /posts/:id` - Update a post by ID
- `DELETE /posts/:id` - Delete a post by ID
### Authors
- `GET /authors` - Get all authors
- `POST /authors` - Create a new author
- `GET /authors/:id` - Get an author by ID
- `PUT /authors/:id` - Update an author by ID
- `DELETE /authors/:id` - Delete an author by ID
### Root
- `GET /` - Returns a simple "hello world" message
## Project Structure
```
.
├── src/
│ ├── _mongo/ # MongoDB connection and models
│ │ ├── index.ts # MongoDB connection setup
│ │ ├── model.author.ts # Author model
│ │ └── model.post.ts # Post model
│ ├── authors/ # Author-related components
│ │ ├── dto.ts # Author Data Transfer Object
│ │ ├── index.ts # Author routes
│ │ └── service.ts # Author service functions
│ ├── posts/ # Post-related components
│ │ ├── dto.ts # Post Data Transfer Object
│ │ ├── index.ts # Post routes
│ │ └── service.ts # Post service functions
│ ├── index.ts # Main application entry point
│ └── type.ts # Common types and interfaces
├── .env.example # Example environment variables
├── api.sh # Helper script for managing the API
├── docker-compose.yml # Docker Compose configuration
├── GUIDE.md # Comprehensive guide for running and testing
├── package.json # Project dependencies
└── tsconfig.json # TypeScript configuration
```
## Development
### Running in Development Mode
```sh
bun run dev
```
This will start the server with hot reloading enabled.
### Environment Variables
The following environment variables can be configured in the `.env` file:
- `PORT`: The port on which the server will run (default: 3000)
- `SERVER_NAME`: The name of the server (default: boilerplate-rest-api-bun)
- `MONGODB_URI`: The MongoDB connection URI (default: mongodb://localhost:27017)
- `MONGODB_DATABASE`: The MongoDB database name (default: boilerplate_db)
- `NODE_ENV`: The environment mode (development, production, etc.)
## MongoDB Management
This project includes [Mongo Express](https://github.com/mongo-express/mongo-express), a web-based MongoDB admin interface. When you start the Docker Compose setup, you can access Mongo Express at http://localhost:8081.
## License
Distributed under the MIT License. See `LICENSE` for more information.