senott / piquetear Goto Github PK

PIQUETEAR

Mobile application, for iOS and Android, to calculate the number of paddocks in a rational rotational grazing system.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Android screenshots:

iOS screenshots:

Built With

• React Native
• Typescript

Getting Started

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

Prerequisites

• Yarn

npm install -g yarn

Installation

1. Clone the repo

git clone https://github.com/senott/Piquetear.git

2. Install Yarn packages

yarn

3. If you're planning to run this project on a Mac, you also need to run the following comands in the project root folder:

cd ios
pod install

Usage

If you have Android Studio installed on your machine, you can run this project in an Android emulator with the following command:

yarn android

If you have Xcode installed on your machine, you can run the project in an iOS emulator with the command:

yarn ios

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 be 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.

Contact

Diego de A. Senott - @senott - [email protected]

Project Link: https://github.com/senott/Piquetear

Acknowledgements