kevmok / elysiajs-api-starter

Packed template / boilerplate to initialize an Bun REST API with ElysiaJS & Drizzle ORM

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bun Starter REST API

This is a bun.sh project bootstrapped with bun init, featuring Drizzle ORM and ElysiaJS setup.
Start developing right away!

πŸ“± Packed template

  • 🍞 Bun
  • ⛓️ TypeScript
  • πŸ’§ Drizzle ORM
  • 🦊 ElysiaJS - ⚑️ Fastest Typescript framework
  • 🌳 Biome for linting, formatting, and sorting imports
  • 🐺 Husky pre-commit hooks

CodeFactor

⚠️ Pre-requisites

  1. Bun installed.

πŸš€ Quick start

To install dependencies:

bun install

To run the development server:

bun run dev

πŸ’§ Drizzle

  1. Create your schemas in src/db/schema see Drizzle Docs for more info.
  2. Generate your migrations based on your schemas by running the following command:
bun run db:generate
  1. Push your schema changes directly to the database by running the following command:
bun run db:push
  1. (Optional) Run Drizzle Kit studio to manage your database by running the following command(see Drizzle Kit Studio Docs for more info.):
bun run db:studio

Roadmap

  • Add support for PostgreSQL
  • Implement JWT-cookie uthentication
  • Add file upload functionality
  • Implement role-based access control (RBAC)
  • Add caching

License

This project is licensed under the MIT License. License: MIT

About

Packed template / boilerplate to initialize an Bun REST API with ElysiaJS & Drizzle ORM

License:MIT License


Languages

Language:TypeScript 96.6%Language:Dockerfile 2.4%Language:Shell 1.0%