diff --git a/Home.md b/Home.md index 4755965..649872f 100644 --- a/Home.md +++ b/Home.md @@ -50,4 +50,64 @@ If this does not work, try to make an api call by yourself (e.g. with Postman). If you get this error you have entered a city name that cannot be geocoded to longitudes and latitudes. -Try to enter a different one. \ No newline at end of file +Try to enter a different one. + +# Installation +## Prerequisites + +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.** +1. Clone the repository: + ```bash + git clone https://git.the1s.de/theis.gaedigk/weather-app.git + ``` + +**or** + +1. Download the latest release from the [releases page](https://git.the1s.de/theis.gaedigk/weather-app/releases/latest). +2. 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 + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Start the development server: + ```bash + npm run dev + ``` +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. \ No newline at end of file