Water my plants

This is the frontend for "Water my plant backend"

View project Report Bug Request Feature

Table of Contents

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

About The Project

(back to top)

Built With

• React.js
• React Video Player

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Raspberry Pi 3b+
• Water Pump
• Relay
• source of water 💦
• a plant
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone hhttps://github.com/ivaylonikolov7/water-me-client.git

2. Install NPM packages

   npm install

3. Enter your path to your backend in secrets.js

   let secrets = {
        BACKEND: 'LINK TO YOUR BACKEND API',
        RPI: 'LINK TO YOUR RASPBERRY',
    }

4. You should clone the backend for this project
5. Follow the instructions
6. Start the backend
7. Now you need the Raspberry Pi controller. You should clone the project
8. Follow the instructions

(back to top)

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". Don't forget to give the project a star! 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)

License

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

(back to top)

Contact

Ivaylo Nikolov - https://ivaylo.codes - [email protected]

(back to top)

Acknowledgments

• https://www.flaticon.com/

(back to top)