moak13 / get_weather

A Weather Application Built Using Flutter

Get Weather

Overview

This is the Get Weather Android app project repository, written with pure Flutter. This Project uses the Flutter Version 1.22.6. To contribute to this project, you need to set FVM on your machine. For packages use the one that best suit the SDK version of the project to avoid errors

Below is the guide for setting up FVM

• FVM is a CLI tool used for managing different flutter SDK versions. This is the https://fvm.app/ link to download.
• Once you click on the link, it redirects you to the fvm site, click on get started and follow the procedure.

Project Description

It is a weather application that allows you to get weather conditions of different locations.

List of Todos:

• Forecast feature
• Light and dark mode (use stacked_themes package for this) This is the https://pub.dev/packages/stacked_themes link to the package
• Weather image
• Change temperature between F and C
• Settings tab (should include 2 and 4 options in it)

Code Style

i. Naming Convention:

Naming Convention	Effective Style	Example
Classes, enum types,typedefs,and type parameters,etensions	PascalCase	An example is HomeScreen
Libraries, packages, directories, and source files, import prefixes	snake_case	An example is home_screen
Class members, top-level definitions, variables, parameters, and named parameters, constants	camelCase	An example is verifiedUser

ii. Style Rule

• Always declare return types in your methods.
• Put required named parameters first.
• Always require non-null named parameters (@required).
• Indent your code where appropriate (e.g Use two-space indentation.)

Contribution Guide

Steps to collaborate on the repository for team members.

Forking and Cloning Repo

• Fork the project.
• Click on the "Code" button on the Repo page.
• Copy the URL for the forked Repo "https://github.com/your-github-username/get_weather.git"
• Open your Code Editor and run git clone "https://github.com/your-github-username/get_weather.git"

Add "Remote To" and "Pull From" Upstream

• Add a Remote to Upstream to your Repo: Using the command : git remote add upstream "https://github.com/mariamadebolahamzat/HNGi8-Stage-2-Task"
• Pull from upstream to download all changes in the project using git pull upstream master

Complete assigned task/issue

• Open the project in your IDE or Code Editor.
• Complete your assigned task.

Create and Commit Changes to a New Branch

When your task is completed:

• Create a new branch with your task name e.g "feat- UserSignUP".
• run: git checkout -b feat/yourTask Push to github;
• git add .
• git commit -m "feat: Inplemented yourTask"

Push New Branch to "Origin" Repository

• To make sure there are no conflict, Pull from upstream using git pull upstream master
• Push your branch changes to the Repo using git push origin "feat/yourTask" note how it end with a branch.

Creating Pull Request

When making a PR, your PR is expected to have the following comments"

• What is the task/issue completed?
• What does the PR actually do?
• How can the PR be manually tested?
• Screenshots(of your implementation - A mobile screen or an APi payload).

get_weather's Issues

Readme Bump

This is open to creating awareness of the version of flutter that safely supports this project and how to set up FVM for those that use a higher version by providing a link to the site.

support landscape mode

This issue is open for someone the wants to make the application support landscape mode

Light and Dark Mode

This issue is open for someone that wants to give the application light and dark mode.

Updating Readme file

A well structured documentation of the app

Forecast Feature UI

This issue is open for someone that wants to give this application a forecast feature UI looks.

Settings Tab

This issue is open for someone that wants to give this application a settings tab.

Temperature Conversion

This issue is open for someone that wants to give this application temperature conversion from F to C and vice versa.

Weather Icon

This issue is open for someone that wants to give this application a weather icon that describes the weather result shown to a user.

Forecast Implementation

This issue is open for someone that wants to give this application a forecast implementation.