Skip to content

Latest commit

 

History

History
208 lines (158 loc) · 6.87 KB

README.md

File metadata and controls

208 lines (158 loc) · 6.87 KB
Raw

Contributors Forks Stargazers Issues MIT License Netlify Status


Logo

React-Native DualTemp Weather


Explore the docs »

View Demo · Report Bug · Request Feature

Now available on the Google Play Store & Apple App Store!

Play Store Link Play Store Link

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before getting started, you'll need to setup your enviorment.

  1. Install a Package Manager (npm or yarn)
  • npm install -g npm
  1. Install Expo CLI
  • npm install --global expo-cli
  1. [OPTIONAL] To publish or build with Expo Application Services (EAS), you'll need to also install the eas-cli:
  • npm install -g eas-cli

Installation

  1. Clone the repo 
    git clone https://github.com/eladkarni/rn-dualtemp-weather.git
  2. Install packages 
    npm install

Usage

If you have all of the dependencies installs, then you are ready to get started!

Required API Keys

You'll also need to make sure you have the required API keys to run the app. One will be for the weather data and another will be for the reverse geolocation (converting a GPS coordinates to a city or county).

The first key you'll need is from Open Weather
The second key you'll need is for the reverse geolocation Geoapify

Once you have both keys, you'll need to dupliacte the app.config.template.js and rename the copy to app.config.js. Then add the API keys in the empty ""

Running The App

To start the project, use the following command:

  npm start

This will start the development server and provide you additional options for testing devices.

Once you are done done testing on your Simulator or using the Expo Go app, you can build the app the following command:

  eas build --profile development --platform android

Note that development is one of the predefined build presets. To see the other options or add your own, checkout eas.json in the root directory. You'll also need to remove app.config.js from the .gitignore as EAS uses that to determain what to upload for processing.



Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.