allan-ja / my-plants_app

React Native mobile app that helps to manage watering of plants

My Plants

Mobile App

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Deployment
3. Contributing
4. Contact
5. Acknowledgments

About The Project

My Plants is a free and open source mobile app that helps to manage watering of plants. App users can add plants to their collection and manage them, and then mark them as watered upon every watering. Users can import plants of other users, in order to water them together, view history of watering for their plants, add images to their plants or set reminders so they get push notification when the plant should be watered.

View screenshots

Built With

• Expo
• React Native
• styled-components

Getting Started

Prerequisites

• Node.js
• My Plants Server
• Sentry

Installation

1. Clone this repo and enter project

   git clone https://github.com/benmotyka/my-plants_app.git
   cd my-plants_app/

2. Install NPM packages

   npm install

3. Run server (please refer to https://github.com/benmotyka/my-plants_api) for more details
4. Create .env file and enter:

   API_URL=<my-plants_server_url> // eg: http://localhost:3000
   
   SENTRY_DSN=<sentry_dsn>
   SENTRY_ORGANIZATION=<sentry_organization>
   SENTRY_PROJECT=<sentry_project_name>
   SENTRY_AUTHTOKEN=<sentry_authorization_token>
   

5. Run app

   npm start

(back to top)

Deployment

1. Add google-services.json file to keys/
2. Convert key to base64-encoded string:

   base64 keys/google-services.json

3. Create eas secret:

   eas secret:create
   
   key=GOOGLE_SERVICES_BASE64
   value=<base64_encoded_string>

4. Increase versionCode in app.config.js
5. Build project

   npm run deploy:build

6. Pubish project

   npm run deploy:publish  

7. Create new release on https://play.google.com/console

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Thanks again!

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

(back to top)

Contact

Ben Motyka - LinkedIn - [email protected]

Project Link: https://github.com/benmotyka/my-plants_app

(back to top)

Acknowledgments

• My Plants Website
• My Plants Server App

(back to top)