Skip to content

Commit 6a7799f

Browse files
committed
chore(docs): add instruction of how to build the documentation
1 parent ba17e48 commit 6a7799f

File tree

4 files changed

+51
-6
lines changed

4 files changed

+51
-6
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
# misc
1515
.DS_Store
16-
.env
1716
.env.local
1817
.env.development.local
1918
.env.test.local

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,48 @@ python -m pip install -r requirements.txt
172172

173173
---
174174

175+
## Documentation
176+
177+
This guide shows how to **run the Annotat3D documentation container** either by pulling the image from Docker Hub or building it locally using Docker Compose.
178+
179+
***Option 1: Pull & Run from Docker Hub***
180+
181+
1. Pull the latest image
182+
You can pull the latest published image from Docker Hub:
183+
```bash
184+
docker pull allansp84/annotat3d-documentation:latest
185+
```
186+
187+
2. Run the container interactively
188+
```bash
189+
docker run --rm -it -p 3000:3000 -e PORT=3000 -e HOST=0.0.0.0 -e CI=true allansp84/annotat3d-documentation:latest
190+
```
191+
192+
3. Access the web application at http://localhost:3000.
193+
194+
195+
***Option 2: Build & Run using Docker Compose***
196+
197+
1. Clone the repository
198+
```bash
199+
git clone https://github.com/cnpem/annotat3d.git
200+
cd annotat3d/docs
201+
```
202+
203+
2. Build and start the container
204+
```bash
205+
docker compose up -d --build
206+
```
207+
208+
3. Access the web application at http://localhost:3000.
209+
210+
4. Stop the container (after closing the documentation)
211+
```bash
212+
docker compose down
213+
```
214+
215+
---
216+
175217
## Code Development Standards
176218

177219
### **General Guidelines**

docs/.env

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
COMPOSE_PROJECT_NAME=
2+
PORT=3000
3+
HOST=0.0.0.0

docs/docker-compose.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
services:
2-
nextjs-app:
2+
annotat3d-documentation:
33
build:
44
context: .
55
dockerfile: Dockerfile
6-
container_name: nextjs-app
6+
container_name: annotat3d-documentation
7+
image: annotat3d-documentation
78
ports:
8-
- "3000:3000" # Expose Next.js app on port 3000
9+
- $PORT:$PORT
910
environment:
1011
- NODE_ENV=production
11-
- PORT=3000
12-
- HOST=0.0.0.0
12+
- PORT=$PORT
13+
- HOST=$HOST
1314
networks:
1415
- app-network
1516

0 commit comments

Comments
 (0)