Feel Good Weather

"Feel Good Weather" is your go-to app for comparing weather like never before! Simply choose your location and a rival spot to see who's winning the weather game. We fetch real-time weather data for both places and deliver the verdict with a witty, humorous twist! Brought to you by SvelteKit, TypeScript, and SCSS for a modern, polished experience.

Table of Contents

• Features
• Usage
• Tech Stack
• Development
  • Installation
  • Running the App
• Using VSCode Devcontainers
  • Prerequisites
  • Getting Started
• Bug Reporting
• Contributing
• License

Features

• Choose your location and a target location.
• Retrieves weather data for both locations.
• Compares the weather conditions and determines the better location.
• Presents the comparison result in a lighthearted, humorous style.

Usage

1. Open the application in your browser.
2. Select your current location.
3. Select a location you want to compare your weather to.
4. Click the compare button.
5. View the results.

Tech Stack

• SvelteKit
• TypeScript
• SCSS
• Vite

Development

Make sure you have the following installed on your local development machine:

• Node.js (v18 or higher)

  Older versions will probably work but are not officially supported.

Installation

1. Clone the repository:

   git clone https://github.com/nsk4/FeelGoodWeather.git
   cd FeelGoodWeather

2. Install dependencies:

   npm install

Running the App

To run the application in development mode:

npx vite --port=4000

This will start the Vite development server. Open your browser and navigate to http://localhost:4000.

Using VSCode Devcontainers

This project includes a devcontainer configuration to set up a consistent development environment using Visual Studio Code Dev Containers. You can read more about devcontainers HERE.

Prerequisites

• Docker installed on your machine.
• Visual Studio Code installed.
• Remote - Containers extension installed in Visual Studio Code.

Getting Started

1. Clone the repository:

   git clone https://github.com/nsk4/FeelGoodWeather.git
   cd FeelGoodWeather

2. Open the project in Visual Studio Code.

3. If prompted, reopen the project in a container by clicking on the green "Open a Remote Window" button in the bottom left corner of the window, then select "Reopen in Container."

4. Visual Studio Code will now build the devcontainer image and start the container with the necessary dependencies for development.

5. Install dependencies:

   npm install

6. You are now ready to start developing inside the devcontainer.

Bug Reporting

If you encounter any bugs or issues, please report them by creating a new issue in the GitHub Issues section of the repository. Provide as much detail as possible, including steps to reproduce the issue, your environment, and any relevant screenshots or logs.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create your feature branch: git checkout -b feature/your-feature-name.
3. Commit your changes: git commit -m 'Add some feature'.
4. Push to the branch: git push origin feature/your-feature-name.
5. Open a pull request.

Please ensure your code adheres to the project's coding standards and passes all tests.

License

This project is licensed under the MIT License. See the LICENSE file for more details.