Skip to content

nashvillefcc/local-weather-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Local Weather App

Nashville FCC's version of the local weather app project completed by the Mentor Night Group Project Team.

Table of Contents

  1. Project Overview
  2. Installation
  3. Contribution
  4. Contributers and Contact Info

Project Overview

This lightweight Web application shows the weather for any given location. The application should prompt users for their device's location, but they should also be able to provide the location manually. Temperature, weather conditions, and a generic image will be shown to the user corresponding to that location's weather. Basic requirements are defined in this freeCodeCamp exercise and expanded features and goals are outlined in our wiki (work in progress).

The code on this GitHub repo is for the front-end side of our application. The APIs we will utilize for weather information and other resources are still TBD. The application is currently being written in standard HTML5, Javascript, and CSS.

This is a teaching exercise and not for sale or distribution without acknowledgment from the team members.

Installation

This application is still a work in progress and not ready to be run yet.

Contribution

We recommend using VS Code as a code editor unless you already have a preferred program. Downloads can be found on the main VS Code site and installation instructions can be found on their documentation pages. We plan to include a VS Code .code-workspace file in the repo to standardize the extensions that the team uses.

Open tickets can be found on the Project Board here: https://github.com/nashvillefcc/local-weather-app/projects/1. If you would like to contribute, please inform the team on the Discord channel before beginning work. For each ticket, create a branch to work on and create a Pull Request when it is complete. Anyone is free to review Pull Requests, and project leads will accept and merge the branches.

Our tickets fall into a Feature -> Task hierarchy, where a Feature is a full user story and there are many Tasks per Feature. Tasks are light on detail; there is an expected outcome on each Task but the implementation is up to the contributor. Generally speaking, Tasks are tagged as either UI tickets (primarily HTML and CSS) or JS tickets (primarily Javascript). Dependencies will be noted in the Blockers section of Task tickets, and all Tasks on a Feature and on the board are currently ordered by priority based on these dependencies.

Each Feature and each Task will have their own Git branch. Tasks will be merged into Features by PR and that Feature will be merged into the Develop branch by PR once it's complete.

  • Feature branches should follow the naming convention "FEATURE/feature-name-or-short-description"
  • Task branches should follow the naming convention "TASK/ticket-name-or-short-description"

Instructions for cloning our source code using Git can be found on our wiki here: https://github.com/nashvillefcc/local-weather-app/wiki/Basic-Git-Tutorial

Additional information, such as design mockups, can be found on our wiki here: https://github.com/nashvillefcc/local-weather-app/wiki

Contributors and Contact Info

Please feel free to message the lead developers with any questions or for an invite to our channel.

About

Nashville FCC's version of the local weather app project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published