Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 2.72 KB

README.md

File metadata and controls

96 lines (66 loc) · 2.72 KB

Project Name

Overview

Summarize your project's purpose, problem solved, key features, user benefits, development context, and main technologies used.

Example:

This client-side JavaScript web application provides real-time weather updates for cities worldwide. It simplifies accessing weather information through an intuitive mobile-first interface, allowing users to input a city name and receive data on temperature, humidity, and conditions.

Developed for the [Course Name] course, applying User-Centred Design practices, agile project management processes, integrating a weather API, and Firebase backend services.

Features

Example:

  • Real-time weather updates for any city.
  • Responsive design for desktop and mobile.
  • Displays temperature, humidity, and weather conditions.

Technologies Used

Example:

  • Frontend: HTML, CSS, JavaScript
  • Backend: Firebase for hosting
  • Database: Firestore
  • API: OpenWeatherMap API

Usage

Example:

  1. Open your browser and visit http://localhost:3000.
  2. Enter the name of the city in the search bar and press enter.
  3. View the weather information displayed on the screen.

Project Structure

Example:

project-name/
├── src/
│   ├── index.html
│   ├── style.css
│   ├── app.js
│   └── components/
├── package.json
├── README.md
└── .gitignore

Contributors

  • Your Name - BCIT CST Student with a passion for creating user-friendly applications. Fun fact: Loves solving Rubik's Cubes in under a minute.
  • Teammate Name - BCIT CST Student, Frontend enthusiast with a knack for creative design. Fun fact: Has a collection of over 50 houseplants.

Acknowledgments

Example:

Limitations and Future Work

Limitations

Example:

  • Currently, the app only supports city-based weather searches.
  • Limited to basic weather parameters like temperature, humidity, and conditions.
  • The user interface can be further enhanced for accessibility.

Future Work

Example:

  • Add support for location-based weather detection using GPS.
  • Implement additional weather parameters like wind speed and UV index.
  • Create a dark mode for better usability in low-light conditions.
  • Integrate user accounts for saving favorite locations.

License

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