Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sleeplessglory/weather-api
An API application showing the current weather in any city across the globe
https://github.com/sleeplessglory/weather-api
api css cypress html javascript jsdoc react sass vite
Last synced: 15 days ago
JSON representation
An API application showing the current weather in any city across the globe
- Host: GitHub
- URL: https://github.com/sleeplessglory/weather-api
- Owner: sleeplessglory
- License: mit
- Created: 2024-09-06T06:05:53.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T08:23:37.000Z (about 2 months ago)
- Last Synced: 2024-10-16T15:35:56.956Z (about 1 month ago)
- Topics: api, css, cypress, html, javascript, jsdoc, react, sass, vite
- Language: JavaScript
- Homepage: https://sleeplessglory.github.io/weather-api/
- Size: 1.36 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
The application has been developed using **HTML**, **CSS**, **SASS**, **JavaScript**, **React**, **npm** and **git**. It has been tested with **Cypress** (E2E and Component testing types) and documented with **JSDoc** (for developers) and **MS Word** (for users). Available on desktop and mobile devices with responsive design.
The purpose of the project is to fetch data from an open API to get weather info for users about any city across the globe.
# Algorithm
Users type any city and click on the button to get weather data. The application trims unnecessary spaces. If a user request is empty, an error asking to provide a city pops up in the weather card. Otherwise the application makes a request to the open weather API. Based on response, the result will be shown for users (either an error or weather data in a city).
# Application styling
## Desktop version
The layout for a desktop version of the application.
## Mobile verison
The layout for a mobile version changes and stores all the elements in a single column.
# Cypress tests
## E2E testing
Here's a video of E2E tests with **Cypress**.
https://github.com/user-attachments/assets/0239230e-d455-4fde-bff3-036e71733e36
## Component testing
And a video of Component tests.
https://github.com/user-attachments/assets/5358ec40-f168-4107-856c-7e2629d53174
# Documentation
## Developer documentation
The application has been documented for developers with **JSDoc**. Available in this repository.
## User documentation
Finally, a documentation for users has been created with **MS Word**. [User documentation.pdf](https://github.com/user-attachments/files/16990299/User.documentation.pdf) version is available.
