Hono-Auth is a simple authentication boilerplate built with Hono.js using Bun and TypeScript, designed to provide essential auth functionality. This project includes four key authentication endpoints and leverages Prisma ORM for database management, Zod for validation, and Swagger UI for API documentation.
- User Authentication: Includes user registration, login, logout, and token refresh.
- Zod Validation: Schema validation for secure data handling.
- Swagger UI: Auto-generated API docs for easy testing and integration.
- Dynamic Role Access Control: Enhanced role management allowing for flexible access control based on user roles and hierarchy.
- Role Hierarchy Filtering: Implemented filtering logic to ensure only appropriate roles are included in access checks, improving security and clarity.
- Hono.js (Bun & TypeScript)
- Prisma ORM (PostgreSQL)
- Swagger UI (Scalar)
- Zod (Data Validation)
| Endpoint | Method | Description |
|---|---|---|
| /auth/register | POST | Register a new user |
| /auth/login | POST | Log in a user |
| /auth/refresh-token | POST | Refresh access token |
| /auth/logout | POST | Log out a user |
| /auth/me | GET | Get user information |
Click to expand
- Clone the repository and install dependencies:
git clone https://github.com/zckyachmd/hono-auth.git
cd hono-auth
bun install-
Create a
.envfile in the root directory:cp .env.example .env nano .env # Edit the variables as needed (see below) #... (.env) DATABASE_URL=postgresql://user:password@localhost:5432/database?schema=public JWT_SECRET=your-secret-token SALT_ROUNDS=10 # Number of rounds for password hashing
-
Migrate the database:
bun prisma migrate dev
-
Start the server:
bun run dev # Open http://localhost:3000/ui in your browser
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
This project is licensed under the MIT License. See the LICENSE file for more information.