WeatherWise is a weather application that provides real-time weather information to users. It allows users to get accurate weather forecasts, view current weather conditions, and access additional details such as humidity, wind speed, and precipitation. The app is built using HTML, CSS, Vanilla JavaScript, and SCSS, following the components approach for the frontend layer and OOP standards for the business logic. The SCSS files follows the 7-1 pattern, which is a popular architecture for organizing SCSS files.
You can access the live version of WeatherWise by visiting: WeatherWise Live
- Real-time weather updates.
- Current weather conditions.
- Five days forecast.
- Following hours forecast.
- Detailed weather information (humidity, wind speed and direction, solar data and much more).
- User-friendly interface.
- Responsive design.
- HTML5
- CSS
- SCSS
- Vanilla JavaScript
- Vite: Used for development and bundling of the application.
- PostCSS: Used for autoprefixing the CSS code.
- StyleLint: Used to ensure code consistency and adherence to standards.
- ESLint: Used with the AirBNB standards to maintain code quality.
- Prettier: Used as a code formatter to ensure consistent code style.
- JSDoc: Used for generating documentation for the codebase.
- GitHub Pages: Used for hosting the WeatherWise application.
- GitHub Actions: Utilized as a simple CI/CD pipeline for automated deployments.
The following APIs are used in the WeatherWise application:
- OpenWeather API: Provides weather details and forecasts.
To run the WeatherWise application locally, follow these steps:
- Clone this repository:
git clone https://github.com/splawskip/WeatherWise.git. - Navigate to the project directory:
cd WeatherWise. - Install the dependencies:
npm install. - Build the application:
npm run buildor usenpm run devto start Vite server. - Open the
index.htmlfile in your preferred web browser or open url generated by Vite.
The codebase of WeatherWise is very well documented using JSDoc comments. If you would like to generate documentation, you can do so by running the following command after installing the project: npm run jsdoc.
This project is licensed under the MIT License. See the LICENSE file for more information.
- Przemysław Spławski 👉 @splawskip
For any inquiries or support, please contact me by choosing some possible contact option available on my profile.