alfin06/WeatherApp

WeatherApp Documentation

Welcome to the official documentation for the WeatherApp. This documentation provides a comprehensive guide on how to set up, use, and contribute to the project.

Table of Contents

1. Introduction
2. Getting Started
   • Prerequisites
   • Installation
3. Weather App
   • User Interface
   • API Integration
4. Dockerization
   • Dockerfile
   • docker-compose.yml
5. Continuous Integration/Continuous Deployment (CI/CD)
   • GitHub Actions Workflow
   • Environment Variables
6. Contributing
7. License

Introduction

WeatherApp is a weather app built using Laravel that allows users to retrieve weather information for specific locations. This documentation aims to provide a clear understanding of the project's structure, setup, and usage.

Getting Started

Prerequisites

Before you begin, ensure you have the following software installed:

• Composer
• Docker

Installation

1. Clone the repository:

   git clone https://github.com/your-username/your-project.git
       cd your-project

2. Install Laravel dependencies:

   composer install

3. Set up your OpenWeatherMap API key in the .env file:

   OPENWEATHERMAP_API_KEY=your-api-key

4. Start the Docker containers:

   docker-compose up -d

   Visit http://localhost:8000 in your browser to access the app.