53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# Weather App
|
|
|
|
This is a simple weather application that allows users to view current weather data for a specified location. The app is built using React and TypeScript, and it fetches weather data from an external API.
|
|
|
|
> For that we use the OpenWeatherMap API. You can get your own API key by signing up at [OpenWeatherMap](https://openweathermap.org/api).
|
|
|
|
## Features
|
|
|
|
- Search for weather by city name
|
|
- Display current weather conditions including temperature, humidity, and wind speed
|
|
- Responsive design for mobile and desktop views
|
|
- Change API key preferences
|
|
- Display weather data in a user-friendly format
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://git.the1s.de/theis.gaedigk/weather-app.git
|
|
```
|
|
2. Navigate to the frontend project directory:
|
|
```bash
|
|
cd weather-app/frontend
|
|
```
|
|
3. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
4. Start the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
5. 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
|
|
1. Get an API key from [OpenWeatherMap](https://openweathermap.org/api).
|
|
2. Click on the "Set API Key" button in the header to enter your API key.
|
|
3. Enter a city name in the search bar and press Enter or click the "Get Weather" button.
|
|
|
|
**Now you can view the current weather data for the specified city!**
|
|
|
|
# Other Information
|
|
## Technologies Used
|
|
- React
|
|
- TypeScript
|
|
- Tailwind CSS
|
|
- OpenWeatherMap API
|
|
- Vite
|
|
|
|
## Version
|
|
This project is currently in development. But will be updated regularly and is expected to be stable soon.
|
|
> There is also coming a public version of the app, which will be hosted on a server. - **Stay tuned for updates!** |