/myloc

๐ŸŒฆ This app provide a local weather stats based on your location.

Primary LanguageTypeScript

myloc

๐ŸŒฅ myloc

๐Ÿ“ฒ Stack

  • React Native
  • Expo [Bare Workflow]
  • Typescript
  • Geolocation
  • React Native SVG
  • React Native Maps
  • Lottie
  • Moti

โœ… Tests

  • Jest
  • Detox
  • Typescript

๐Ÿšš Api

โœจ Features

  • Fetch your weather stats from your location
  • Show your position on map
  • and more...

โš’๏ธ Getting Started

  • Npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js

  • Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. Download Yarn

  • React Native CLI is a package that contains tools and helpers for React Native projects in form of a command line tool. Download React Native CLI

  • Expo CLI is a command line app that is the main interface between a developer and Expo tools. Download Expo CLI

  • Android Studio is a great tool to run an emulator and then start your app Download Android Studio

macOS users - you can use the Iphone Emulator provide by Xcode

๐Ÿš€ Install and Run

โฌ‡ Follow the steps below to download and run the project

1. git clone https://github.com/YuriPerro/myloc.git
2. cd myloc
3. yarn or npm install
4. create a .env file on the root of project, and put your weather api key like '.env.example'
5. yarn ios or yarn android

๐Ÿšฆ Run tests

unit tests

For unit tests just run yarn test and wait the results

e2e tests

For automated tests, you need to generate build and run tests for the platform of you choice. First, install detox-cli here Download Detox

๐ŸŽ iOS

Before, change device type in the section 'ios.sim.debug' on the package.json file, to your ios emulator name.

  • Generate build with detox build --configuration ios.sim.debug
  • Start the project yarn start
  • Then, Run e2e tests with detox test -c ios.sim.debug

๐Ÿค– Android

Before, change device avdName in the section 'android.emu.debug' on the package.json file, to your android emulator name.

  • Generate build with detox build --configuration android.emu.debug
  • Start the project yarn start
  • Then, Run e2e tests with detox test -c android.emu.debug

๐Ÿ“ฆ APK

For Android users that prefer to see standalone app

๐Ÿ“ƒ License

  • Licensed for users and contributors under MIT license.

Developed with ๐Ÿงก by Yuri Baumgartner