Welcome to the weather-app wiki!

This web application is one of my first ones that I have build.

This application is still work in progress. So be paitiend with me, if the app has still some errors. If you notice one, please create a new issue and I will take care of that.

Error codes

Here you will find help when you get an error message. The error code should be next to the error starting with an x.

x30

For developers: This error is triggered from the frontend/src/utils/changeAPIcookie.ts file

This error you will get, when there is something wrong with setting your API key. Please create an issue if you get this error.

To fix this error you can try to add the api key manually to your cookies. Follow these steps:

Naviagte to the cookies tab in your browser
Create an cookie with name apiKey and in the value paste your api key.

This should fix your problem!

x32

For developers: This error is triggered from the frontend/src/utils/apiFunc.ts file

When you get this error please create an issue and I will take care of that error.

For now, try to reinstall the application.

x4010

For developers: This error is triggered from the frontend/src/utils/apiFunc.ts file

When you get this error, the api function is having trouble with you api key.

To fix this error, check the api key that you have entered.

Do not put spaces between the letters
Check if you have pasted the api key from OpenWeatherMap correctly. (The free api key is completely sufficient)

If this does not work, try to make an api call by yourself (e.g. with Postman). Or get in touch personally with OpenWeatherMap

x4040

For developers: This error is triggered from the frontend/src/components/WeatherForm.tsx file

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.

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)

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:

git clone https://git.the1s.de/theis.gaedigk/weather-app.git

Download the latest release from the releases page.
Unzip the downloaded file to your desired location.

2nd step - Using Node.js and npm

Navigate to the frontend project directory:
```
cd weather-app/frontend
```
Install dependencies:
```
npm install
```
Start the development server:
```
npm run dev
```
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.

2nd step - Using Docker

Navigate to the root path project directory:
```
cd weather-app
```
Run in a Docker container:
```
docker compose up -d --build
```
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.