/Addy-React-Native

A React Native based hybrid app for Addy

Primary LanguageObjective-CApache License 2.0Apache-2.0

Addy Addy-React-Native

Join the chat at https://gitter.im/Addy-Smart-Addresses/Addy-React-Native

A React Native based app for Addy

Addy is a web app that enhances the addressing system of the world. Instead of remembering long addresses, Addy generates a unique 7-digit code based on the latitudinal and longitudinal coordinates of any position. The code is so accurate that every building in the world has been assigned a different 'Addy' with a minimum distance of 11.132 meters.

Gitter channel link

https://gitter.im/Addy-Smart-Addresses

Contribution Guidelines

https://github.com/addy-org/Addy-React-Native/wiki/Contribution-Guidelines

Running the app in your system

  1. Install React Native into your system
  2. After forking the project, git clone the repository onto your local environment:
git clone https://github.com/YOUR-USERNAME/Addy-React-Native.git
  1. Install the dependencies using:
npm install

or

yarn install
  1. Run the following command from inside your project directory
react-native run-android //for running on android simulator/device

or

react-native run-ios //for running on iOS simulator on MacOS

Getting Started with Contributing:

  1. After forking the project, git clone the repository onto your local environment:
git clone https://github.com/YOUR-USERNAME/Addy-React-Native.git
  1. Create a separate Git branch
git branch <your_new_branch_name>
  1. Git checkout your branch
git checkout <your_new_branch_name>
  1. Open up the project in your favorite code editor (e.g. Atom).
  2. Make your changes.
  3. Git add and commit your changes.
git add <file_name>
git commit -m <insert_commit_comment>
  1. Git push your changes as well as your new branch.
git push -u origin <your_branch_name>
  1. Go to the GitHub repository and submit a Pull Request.