Added dev files for docker

Author: max-programming

.env.sample

@@ -1,16 +1,9 @@
-# For Development
 DATABASE_URL="file:db/db.sqlite"
 
-# For Production
-# DATABASE_URL="file:/app/db/db.sqlite"
-
-# For Sentry Error Handling
+# For Production Only
 VITE_SENTRY_DSN=""
-
 VITE_ANALYTICS_SCRIPT=""
 VITE_ANALYTICS_WEBSITE_ID=""
-
-# Umami Analytics
 UMAMI_DATABASE_URL=postgresql://umami:umami@umami-db:5432/umami
 UMAMI_APP_SECRET=some-long-random-secret
 UMAMI_DB_NAME=umami

Dockerfile.dev

@@ -0,0 +1,21 @@
+FROM oven/bun
+
+# set the working directory
+WORKDIR /app
+
+# copy package json and lockfile to the container
+COPY package.json bun.lock ./
+
+# install dependencies (including dev dependencies)
+RUN bun install
+
+# copy the rest of the application code
+# Note: In development, this will be overridden by volume mount
+COPY . .
+
+# expose the port
+EXPOSE 3000
+
+# run migrations and start the development server
+# This command can be overridden in docker-compose.dev.yml
+CMD ["sh", "-c", "bun run db:migrate && bun run dev"] 

README.md

@@ -6,12 +6,52 @@ You can try it out at [whim.day](https://whim.day)
 
 ## Running it locally
 
-### Prerequisites
+### Option 1: With Docker (No Bun installation required)
+
+If you prefer not to install Bun on your machine, you can run the entire development environment using Docker:
+
+#### Prerequisites
+- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
+
+#### Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/max-programming/whim.git
+cd whim
+```
+
+#### Set up environment variables
+
+```bash
+cp .env.sample .env
+```
+
+Edit `.env` with your preferred values for development.
+
+#### Run with Docker
+
+```bash
+docker-compose -f docker-compose.dev.yml up
+```
+
+The app will be available at `http://localhost:3000`. Your code changes will be automatically reflected thanks to volume mounting.
+
+To stop the development server:
+
+```bash
+docker-compose -f docker-compose.dev.yml down
+```
+
+### Option 2: Local Development with Bun
+
+#### Prerequisites
 
 - [Bun](https://bun.sh/) (for package management and running the app)
 > Or Node with NPM, Yarn or PNPM is also fine
 
-### Installation
+#### Installation
 
 Clone the repository and install dependencies:
 
@@ -21,18 +61,19 @@ cd whim
 bun install
 ```
 
-### Fill in the .env file
+#### Fill in the .env file
 
 ```bash
 cp .env.sample .env
 ```
 
-### Run the migrations
+#### Run the migrations
 
 ```bash
 bun run db:migrate
 ```
-### Running the App
+
+#### Running the App
 
 Start the development server:
 

docker-compose.dev.yml

@@ -0,0 +1,18 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev
+    container_name: whim-app-dev
+    restart: unless-stopped
+    volumes:
+      - .:/app # Mount entire project for live reload
+      - /app/node_modules # Prevent overwriting node_modules
+      - ./db:/app/db # Database volume
+    env_file:
+      - .env
+    ports:
+      - 3000:3000 # Direct port exposure for development
+    environment:
+      - NODE_ENV=development
+    command: bun run dev # Use development command