Merge pull request #125 from Project-CARPI/package-consistency

Docker Setup

Author: mirmirmirr

.dockerignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+build
+.git
+.env
+docker-compose.yml
+Dockerfile

Dockerfile

@@ -0,0 +1,9 @@
+FROM node:24.14.0-alpine
+
+WORKDIR /app
+COPY package*.json ./
+RUN npm ci
+COPY . .
+EXPOSE 5173
+
+CMD ["npm", "run", "dev"]

README.md

@@ -50,7 +50,9 @@ node -v
 npm -v
 ```
 
-### Installation
+If you plan to use Docker, ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
+
+### Local Installation
 
 1. Clone the repository and navigate into the project directory:
 
@@ -74,10 +76,35 @@ npm run dev
 
 By default, Vite serves the app on localhost (usually `http://localhost:5173`).
 
-To expose the app on your local network:
+### Docker Installation
+
+If you prefer an isolated containerized environment, you can use our Docker Compose setup.
+
+1. Clone the repository and navigate into the project directory:
+
+```bash
+git clone https://github.com/Project-CARPI/site.git
+cd site
+```
+
+2. Build the image and spin up the container:
+
+```bash
+docker compose up --build
+```
+
+To run the container in detached mode (in the background), append the -d flag:
+
+```bash
+docker compose up -d
+```
+
+The app will now be accessible at `http://localhost:5173` (or the port specified in your docker compose configuration).
+
+To stop the container, run:
 
 ```bash
-npm run dev -- --host
+docker compose down
 ```
 
 ### Available Scripts
@@ -137,6 +164,7 @@ npm run preview
 - [@dnd-kit](https://dndkit.com/)
 - [Framer Motion](https://www.framer.com/motion/)
 - [Zod](https://zod.dev/)
+- [Docker](https://www.docker.com/)
 
 ## Contributing
 

docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  web:
+    build: .
+    image: carpi-dev:latest
+
+    # expose port 5173
+    ports:
+      - "5173:5173"
+
+    # mount the current directory to /app in the container
+    volumes:
+      - .:/app
+      - /app/node_modules
+
+    # interactive terminal
+    stdin_open: true
+    tty: true

package.json

@@ -8,7 +8,7 @@
     "npm": "~11.12.0"
   },
   "scripts": {
-    "dev": "vite",
+    "dev": "vite --host",
     "build": "tsc -b && vite build",
     "lint": "eslint .",
     "preview": "vite preview",