clean up
This commit is contained in:
43
README.md
43
README.md
@@ -1,6 +1,31 @@
|
||||
# Game Timer
|
||||
|
||||
Multi-player chess timer with carousel navigation
|
||||
Multi-player game-timer timer with carousel navigation
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
game-timer/
|
||||
├── docs/ # Documentation and project resources
|
||||
│ └── screenshots/ # Application screenshots
|
||||
├── public/ # Static assets and public-facing resources
|
||||
│ ├── css/ # CSS stylesheets
|
||||
│ ├── images/ # Images used by the application
|
||||
│ ├── icons/ # App icons for PWA
|
||||
│ ├── audio/ # Audio files
|
||||
│ ├── index.html # Main HTML entry point
|
||||
│ ├── manifest.json # PWA manifest
|
||||
│ └── sw.js # Service Worker
|
||||
├── src/ # Source code
|
||||
│ └── js/ # JavaScript files
|
||||
│ ├── core/ # Core application logic
|
||||
│ ├── ui/ # UI-related code
|
||||
│ ├── services/ # External services integration
|
||||
│ └── utils/ # Utility functions
|
||||
├── Dockerfile # Docker container definition
|
||||
├── .dockerignore # Files to exclude from Docker build
|
||||
└── package.json # Project metadata and dependencies
|
||||
```
|
||||
|
||||
# PWA Containerized Deployment
|
||||
|
||||
@@ -23,7 +48,7 @@ git clone https://gitea.virtonline.eu/2HoursProject/game-timer.git
|
||||
cd game-timer
|
||||
```
|
||||
|
||||
### 2. Build the docker image
|
||||
### 2. Build the Docker image
|
||||
|
||||
From the repository root, run the following command to build your Docker image:
|
||||
|
||||
@@ -56,7 +81,7 @@ docker logs game-timer-container
|
||||
After running the container, open your web browser and navigate to:
|
||||
|
||||
```bash
|
||||
http://localhost
|
||||
http://localhost:8080
|
||||
```
|
||||
|
||||
### 5. Terminate
|
||||
@@ -65,4 +90,14 @@ To stop your running game-timer-container, use:
|
||||
|
||||
```bash
|
||||
docker stop game-timer-container
|
||||
```
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
For local development without Docker, you can use:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
This will start a local development server and open the application in your browser.
|
||||
Reference in New Issue
Block a user