Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.1 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.1 KB
Raw

KAIST Village Hall

Expo Hono Drizzle Postgres

Introduction

KAIST Village Hall is a mental care app designed specifically for the KAIST community. It enables users to share their concerns anonymously, receive professional counseling, and engage in small challenges to positively enhance their lives. This platform is dedicated to creating a supportive environment that fosters personal growth and well-being.

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 files and, if necessary, modify them according to your local environment settings.

    cp packages/api/.env.example packages/api/.env
cp packages/app/.env.example packages/app/.env

  2. Install dependencies:

    Use Bun to install all necessary dependencies.

    bun install

  3. Database Setup:

    Start the database container using Docker, then run database migrations to set up the required database schema.

    cd packages/api
bun db up -d # This will start the database container in detached mode
bun db:migrate
cd -

  4. Running the application:

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

    # Terminal 1
cd packages/app
bun start

# Terminal 2
cd packages/api
bun dev

Commit Guidelines

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