Skip to content

haydenmlh/CatchTheClimate

Repository files navigation

Logo

CatchTheClimate

CatchTheClimate is a React Native app to search for the weather in any city / postcode in the world using the OpenWeather API. The current weather and a 7 day forecast is displayed for the searched city.

Getting Started

Prerequisites

  1. Refer to React Native documentation for setting up the development environment.

Installation

Android

  1. Get a free API key by registering an account at https://openweathermap.org/api

  2. Clone the repo

git clone https://github.com/haydenmlh/CatchTheClimate.git
  1. Install NPM packages
npm install
  1. Open an Android emulator or connect an Android phone to the development machine with USB debugging enabled.

  2. In the root directory of the project, run in a terminal:

npx react-native run-android

Roadmap

  • Search Function
  • Display Current Weather and 7-day Forecast
  • Migrate to Typescript
  • Create types for Typescript
  • Link Welcome splash screen and info display screen
  • Save city
  • Add Offline indicator
  • Add Settings screen for changing API Key, units and theme
  • Add multiple cities feature
  • Add Jest testing
  • Add CI/CD on Github

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

BSD 3-Clause

About

A React Native weather app for your everyday needs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published