Skip to content

Commit 0573dc0

Browse files
committed
update readme
1 parent efc766e commit 0573dc0

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ node -v
5050
npm -v
5151
```
5252

53-
### Installation
53+
If you plan to use Docker, ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
54+
55+
### Local Installation
5456

5557
1. Clone the repository and navigate into the project directory:
5658

@@ -80,6 +82,37 @@ To expose the app on your local network:
8082
npm run dev -- --host
8183
```
8284

85+
### Docker Installation
86+
87+
If you prefer an isolated containerized environment, you can use our Docker Compose setup.
88+
89+
1. Clone the repository and navigate into the project directory:
90+
91+
```bash
92+
git clone https://github.com/Project-CARPI/site.git
93+
cd site
94+
```
95+
96+
2. Build the image and spin up the container:
97+
98+
```bash
99+
docker compose up --build
100+
```
101+
102+
To run the container in detached mode (in the background), append the -d flag:
103+
104+
```bash
105+
docker compose up -d
106+
```
107+
108+
The app will now be accessible at `http://localhost:5173` (or the port specified in your docker compose configuration).
109+
110+
To stop the container, run:
111+
112+
```bash
113+
docker compose down
114+
```
115+
83116
### Available Scripts
84117

85118
- `npm run dev`: Start the Vite development server.
@@ -137,6 +170,7 @@ npm run preview
137170
- [@dnd-kit](https://dndkit.com/)
138171
- [Framer Motion](https://www.framer.com/motion/)
139172
- [Zod](https://zod.dev/)
173+
- [Docker](https://www.docker.com/)
140174

141175
## Contributing
142176

0 commit comments

Comments
 (0)