Update README with Docker deployment instructions and bump version to 0.0.1-beta in package.json
This commit is contained in:
61
README.md
61
README.md
@@ -47,6 +47,11 @@ The OSSM Configurator is a React-based single-page application built with Vite.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
**Option 1: Using Docker (Recommended)**
|
||||
- Docker Desktop or Docker Engine
|
||||
- Docker Compose
|
||||
|
||||
**Option 2: Local Development**
|
||||
- Node.js (v16 or higher recommended)
|
||||
- npm or yarn
|
||||
|
||||
@@ -90,6 +95,62 @@ Preview the production build locally:
|
||||
npm run preview
|
||||
```
|
||||
|
||||
## Docker Deployment
|
||||
|
||||
### Development with Docker Compose
|
||||
|
||||
Run the application in development mode with hot reload:
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose-dev.yml up
|
||||
```
|
||||
|
||||
The application will be available at `http://localhost:5173` with hot module replacement enabled.
|
||||
|
||||
To run in detached mode (background):
|
||||
```bash
|
||||
docker-compose -f docker-compose-dev.yml up -d
|
||||
```
|
||||
|
||||
To stop the development container:
|
||||
```bash
|
||||
docker-compose -f docker-compose-dev.yml down
|
||||
```
|
||||
|
||||
### Production with Docker Compose
|
||||
|
||||
Build and run the production image:
|
||||
|
||||
```bash
|
||||
docker-compose up --build -d
|
||||
```
|
||||
|
||||
The application will be available at `http://localhost:80`
|
||||
|
||||
To run without rebuilding (if image already exists):
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
To stop the production container:
|
||||
```bash
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
To view logs:
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
### Using Pre-built Docker Images
|
||||
|
||||
The project includes GitHub Actions workflows that automatically build and publish Docker images to GitHub Container Registry (ghcr.io) on releases. You can pull and run the latest release image:
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/<your-username>/<your-repo-name>:V0.0.1-BETA
|
||||
docker run -d -p 80:80 ghcr.io/<your-username>/<your-repo-name>:V0.0.1-BETA
|
||||
```
|
||||
|
||||
## Configuration Data
|
||||
|
||||
The application uses JSON data files located in `website/src/data/`:
|
||||
|
||||
Reference in New Issue
Block a user