https://github.com/frnn4268/weather-app

A weather application built using React and Vite.js. This app allows users to view current weather information and forecast data for different locations.
https://github.com/frnn4268/weather-app

cypress docker docker-compose docker-image openweathermap-api reactjs vitejs

Last synced: 7 days ago
JSON representation

A weather application built using React and Vite.js. This app allows users to view current weather information and forecast data for different locations.

• Host: GitHub
• URL: https://github.com/frnn4268/weather-app
• Owner: Frnn4268
• Created: 2024-08-14T03:35:32.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-08-15T05:46:35.000Z (3 months ago)
• Last Synced: 2024-10-10T22:23:37.284Z (28 days ago)
• Topics: cypress, docker, docker-compose, docker-image, openweathermap-api, reactjs, vitejs
• Language: JavaScript
• Homepage:
• Size: 926 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Weather App

A simple weather application built using React and Vite.js. This app allows users to view current weather information and forecast data for different locations.

## Features

- View current weather data.

- Search for weather information by location.

- Responsive design for mobile and desktop views.

- Shows detailed weather data for specific cities.

## Technologies Used

- **React**: Frontend library for building user interfaces.

- **Vite.js**: Build tool for faster development and optimized builds.

- **CSS**: For styling the application.

- **OpenWeather API**: For fetching weather data.

## Getting Started

To get started with this project, follow these steps:

### Prerequisites

Make sure you have the following installed on your machine:

- [Node.js](https://nodejs.org/) (version 18 or later)

- [Docker](https://www.docker.com/products/docker-desktop) (if you want to run the application in a Docker container)

### Clone the Repository

Clone the repository using Git:

    git clone https://github.com/Frnn4268/weather-app.git

    cd weather-app

### Install Dependencies

Install the required dependencies using npm:

> npm install

### Run the Application Locally

To run the application locally in development mode, use the following command:

> npm run dev

The application will be available at  `http://localhost:8080/`

### Build the Application

To build the application for production, use the following command:

>  npm run build

The production build will be generated in the `dist` directory.

## Run the Application with Docker

If you prefer to run the application using Docker, follow these steps:

1. Build the Docker Image

	>docker build -t weather-app .

2. Run the Docker Container

	>docker run -p 3000:3000 weather-app

The application will be available at `http://localhost:3000`.

### Run the Application with Docker Compose

To run the application using Docker Compose, follow these steps:

1. Build and Start the Services

	> docker-compose up --build

	This command will build the Docker image if it doesn't already exist and start the container. The application will be available at `http://localhost:3000`.

2. Stopping the Services

	To stop the running services, use the following command:

	> docker-compose down

## Configuration

Update the `.env` file in the root of the project to include your OpenWeather API key and any other environment-specific variables.

    VITE_APP_WEATHER_ID="your_OpenWeather_Api_key"

## Explanation

- **Project Overview**: A brief description of what the project does.

- **Features**: Key features of the application.

- **Technologies Used**: Technologies and tools used in the project.

- **Getting Started**: Steps to set up and run the project locally.

- **Docker Instructions**: Instructions for running the app using Docker.

- **Configuration**: How to set up environment variables.