House Plants

"House Plants" is a web application that lets you search an API for a specific house plant and provides you with all the necessary information. With "House Plants", you can keep track of all your house plants and customize your profile to manage them better.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About the project

Developed using React and Material UI for a modern and user-friendly desig

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This application is already deployed and ready to use here. (The API key access will change in the near future).

Prerequisites

If you want to download the project and run it locally follow the next steps (make sure you're on the right directory with the src folder):

• npm

  npm install

  • mui

  npm install @mui/icons-material @mui/material @emotion/styled @emotion/react

  • To run Vite environment

  npm run dev

Installation

1. Get a free API Key at https://perenual.com/docs/api
2. Clone the repo

   git clone https://github.com/Vvan31/HousePlants.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Search an API for a specific house plant and view detailed information about it
• Save plants to your profile and keep track of them
  • Add notes and photos to your saved plants to personalize your profile
• View a calendar that displays upcoming watering and fertilizing schedules for your plants
• Customizable profile name and profile photo
• Share your plats list
• Export others plants list into your profile

See the open issues for a full list of proposed features (and known issues).

(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

Vivian Osorio - @iamvvan_ - v31.osorio@gmail.com

Project Link: https://github.com/Vvan31/HousePlants

(back to top)

Acknowledgments

• Perenual plants API

(back to top)