docs: enhance installation instructions and clarify Docker usage in README

This commit is contained in:
2025-08-01 21:43:02 +02:00
parent ee6469379f
commit e56e998467

View File

@@ -13,24 +13,63 @@ This is a simple weather application that allows users to view current weather d
- Display weather data in a user-friendly format
## Installation
### Prerequisites
1. Clone the repository:
To install and run this application, you need the following tools:
- Git (for cloning the repository)
**and**
- Node.js (v14 or higher)
- npm (Node Package Manager)
**or**
- Docker (for running the app in a container)
### 1st step - Get the source code
**You can either clone the repository or download the latest release. Keep in mind that the cloned version may contain bugs.**
- Clone the repository:
```bash
git clone https://git.the1s.de/theis.gaedigk/weather-app.git
```
2. Navigate to the frontend project directory:
**or**
- Download the latest release from the [releases page](https://git.the1s.de/theis.gaedigk/weather-app/releases/latest).
- Unzip the downloaded file to your desired location.
#### 2nd step - Using Node.js and npm
1. Navigate to the frontend project directory:
```bash
cd weather-app/frontend
```
3. Install dependencies:
2. Install dependencies:
```bash
npm install
```
4. Start the development server:
3. Start the development server:
```bash
npm run dev
```
5. Open your browser and go to `http://localhost:7002` to view the app.
4. Open your browser and go to `http://localhost:7002` to view the app.
**Note:** There is also a backend server directory, which is currently not in use. - You can ignore it for now.
**or**
#### 2nd step - Using Docker
1. Navigate to the root path project directory:
```bash
cd weather-app
```
2. Run in a Docker container:
```bash
docker compose up -d --build
```
3. Open your browser and go to `http://localhost:7002` to view the app.
**Note:** There is also a backend server directory, which is currently not in use. - You can ignore it for now.
## Usage
@@ -53,4 +92,4 @@ This is a simple weather application that allows users to view current weather d
## Version
**On this branch you will find the latest version of the weather app, which includes several improvements and bug fixes. But it is not yet fully functional. The app is still in development, and some features may not work as expected.**
**On this branch (main) you will find the latest version of the weather app, which includes several improvements and bug fixes. But it is not yet fully functional. The app is still in development, and some features may not work as expected.**