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

• Frontend: HTML, CSS, JavaScript
• Build Tool: Vite
• Backend: Firebase for hosting
• Database: Firestore

---

Usage

To run the application locally:

1. Clone the repository.
2. Install dependencies by running npm install in the project root directory.
3. Start the development server by running the command: npm run dev.
4. Open your browser and visit the local address shown in your terminal (usually http://localhost:5173 or similar).

Once the application is running:

1. Browse the list of hiking trails displayed on the main page.
2. Click the heart icon (or similar) to mark a trail as a favorite.
3. View your favorite hikes in the favorites section.

---

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:

• Weather data sourced from OpenWeatherMap.
• Code snippets for ___ algoirthm were adapted from resources such as Stack Overflow and MDN Web Docs.
• Icons sourced from FontAwesome and images from Unsplash.

---

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.

---