/ara-api

Restful API for Ara, KAIST's official community service

Primary LanguageTypeScriptMIT LicenseMIT

Ara API

Bun Hono Drizzle MySQL

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker
  • Bun v1.1 (JavaScript runtime and package manager)

Installation

  1. Set up environment variables:

    Copy the example environment file and if necessary, modify it according to your local environment settings.

    cp .env.example .env
  2. Install dependencies:

    Use Bun to install all necessary dependencies.

    bun install
  3. Database Setup:

    Start the database container using Docker.

    docker compose up -d # This will start the database container in detached mode

    Run database migrations to set up the required database schema.

    bun db:migrate
  4. Running the application:

    To start the application in development mode, use the following command:

    bun dev

Commit Guidelines

This project uses gitmoji for commit messages. Check the gitmoji specification for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.