Welcome to Plant Pals β the ultimate companion for plant enthusiasts! Whether you're a seasoned gardener or just starting your plant journey, Plant Pals is here to help you build and nurture your plant collection while engaging with a thriving community of plant lovers.
With Plant Pals, you can search through a vast database of plants, add your favorites to a personal collection, and earn badges as your plant family grows! Share your green wisdom, ask questions, and offer advice in the forum section. Your plant care journey is gamified, so the more plants you collect, the higher your status as a plant expert grows. From "Seedling" to "Pro Botanist," each tier unlocks fun badges and new challenges!
Letβs grow together and bring some greenery into our daily lives β one plant at a time! π΅πΈπ»
Clone the repository:
git clone https://github.com/yourusername/plant-pals.git
cd plant-pals
Install the dependencies:
npm install
Set up environment variables:
.env
file in both client and server directories.Start the development server:
npm run dev
This will start both the frontend and backend servers.
client/src/components/
- Contains reusable React components.server/models/
- MongoDB models for users, posts, plants, and comments.server/resolvers.js
- GraphQL resolvers for queries and mutations.server/typeDefs.js
- GraphQL schema definitions.Perenual API: The app integrates with Perenual API to fetch plant data based on user search terms. This API provides plant information such as species, sunlight needs, and watering frequency.
In order to make API requests, ensure you have a valid API key from the Perenual API and set it up in your .env
file as follows:
You can sign up for a free Perenual API key here.
We welcome contributions! If you would like to contribute to Plant Pals, please fork the repository and submit a pull request. Please follow the existing code style and conventions.
git checkout -b feature-name
git commit -m 'Add some feature'
git push origin feature-name
N/A
This project is a collaborative effort. Our team members are:
We appreciate the hard work and contributions of all team members in making this project possible.