PlantPals is a platform designed to help first-time plant parents nurture their plants with ease. The application, still in development, provides detailed plant care instructions, such as watering and sunlight requirements, along with interactive guides to help users keep their plants healthy. Users can also explore different plant species and customize their care journey.
Deployed Site: PlantPals Live
Final Project Blog: Read the Blog Post
Author(s):
- Ivy Kutswa - Project Lead
To get started with PlantPals locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/plantPals.git
-
Navigate to the project directory:
cd plantPals -
Install the necessary dependencies:
npm install
-
Add your environment variables:
- Create a
.envfile at the root of your project. - Add your API key for the plant database:
REACT_APP_PLANT_PERENUAL_API_KEY=your_api_key_here
- Create a
-
Start the development server:
npm start
Once you have the application running, you can explore the following features:
- Search for plant species by their common or scientific name.
- View detailed care instructions for each plant.
- Interactive plant care guide with step-by-step instructions on watering and sunlight needs.
Contributions are welcome! If you would like to contribute to PlantPals, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit (
git commit -m 'Add new feature'). - Push your changes (
git push origin feature-branch). - Create a pull request.
Please make sure to follow the contribution guidelines before submitting a pull request.
Here are some related projects that might inspire or complement PlantPals:
- [Plant Parent by XYZ]
- [Green Thumb Guide]
This project is licensed under the MIT License. You are free to use, modify, and distribute this project, but please ensure that you give credit to the original authors due to copyright.
