Skip to content

Latest commit

 

History

History
170 lines (114 loc) · 5.9 KB

README.md

File metadata and controls

170 lines (114 loc) · 5.9 KB
Raw

Sweather

image

Index

Introduction

Sweather is a weather app that can be used to get the current weather in a city. It is a simple, yet powerful application.

Sweather stands for "Simple weather".

The main goal behind this project is to learn React Native along with Figma prototyping by creating an app that provides users valuable data. The Figma design was created in advance in order to have a clear idea of what the app should be before programming and to become a development challenge.

Features

  • Get the weather of a city specifying its name
  • Get the weather of a city using the current location
  • Dynamic weather details background, depending on the requested city
  • Dark mode
  • Spanish support

Installation

Install the project node and npm version via nvm by using nvm install.

Then install yarn in case you don't have it and create a .env file, following the contents at .env.template

Once done this run yarn install to install the dependencies and... That's it!

Usage

Feel free to run the app with yarn start.

Testing

Unit tests

You can run the unit tests using the command:

yarn test

HTTP Requests

With the REST Client Extension you can test OpenWeather and Unsplash APIs. Please find them at the tests folder.

Technologies

Architecture

Sweather architecture is composed by the following folders:

  • Components: The components used along all the app. These are basic components such as buttons, icons, etc. Some React Native components have been redefined at this folder, in order to customize them to allow light and dark modes.

  • Hooks: Autogenerated by Expo when creating the app. This folder contains the following hooks:

    • useCachedResources: This hook loads resources before the app starts and shows an splash screen.
    • useColorScheme: Retrieves if the system has a light or dark mode enabled.

    Wrappers for Weather and Wallpaper API calls:

    • useWeatherForecast: Retrieves weather and forecast data.
    • useWallpaper: Retrieves the wallpaper for a given location.

  • Navigation: It contains the navigation stack along with the routes.

  • Screens: Each folder represents the components used in each screen. The screens are:

    • LocationRequest: Shows an input where the user can enter its location.
    • LocationDetails: Shows the weather of the selected location.
    • WallpaperInfo: Contains information about the wallpaper shown at one location.
    • NotFound: Route not found sample screen. Not used in the app.

  • Services:

    • Wallpaper: Unsplash API wrapper for getting a wallpaper of a desired location. It searchs a location at Unsplash and gets one of the first images.
    • Weather: Given a string with the location or their coordinates, it retrieves the weather data.

  • Types: The type declaration for React Navigation.

  • Assets: The font and the images used in the app.

Release

First, login in Expo Associated Services (EAS). The below commands should finally output the user's name.

npm i -g eas-cli
eas login
eas whoami

Do not forget to add your .env variables as secrets in Expo Go.

The default build format is enhanced for the Play Store, this is Android App Bundle (.aab). In case you want to generate an apk please create eas.json file.

Now you can run your build with the following command:

# Development
eas build -p android --profile preview

# Production
eas build -p android --profile production

Note: you can name the profile whatever you like. We named the profile preview. However, you can call it local, emulator, or whatever makes the most sense for you.

Submit

For submitting the app to the Play Store you'd need to follow the steps:

  1. Create Google Cloud key following the tutorial.
  2. Save the key in the project as play-console-account-key.json.
  3. Ensure the configuration in eas.json covers submit.
  4. Specify the appropriate version in app.json. Edit the "version" property.
  5. Submit your application choosing your build.
eas submit --platform android

FAQ

Q: How do I update expo dependencies for best compatibility with current expo version?

A: Just use yarn expo install --check

Further information

To learn more about React and React native, you can check the docs at the Technologies section.