GreenPets
Introduction
GreenPets is an innovative platform designed for plant lovers and aspiring plant parents. This unique tool helps users find the perfect plants that suit their lifestyle and expertise level. Whether you're looking for indoor or outdoor plants, and regardless of your green thumb proficiency, GreenPets offers a tailored selection to meet your needs.
Features and Benefits
- Personalized Plant Recommendations: Users input their preferred plant type and rate their gardening skills. GreenPets then provides a variety of plant options that are ideal for the user's lifestyle and experience.
- Future Updates: Features like favoriting plants for future reference will be available for authenticated users.
Installation and Setup
To install GreenPets, follow these steps:
- Clone the repository.
- Install dependencies for both server and client:
cd server
npm install
cd ../client
npm install
Built With
GreenPets is built using a range of technologies, ensuring a robust and scalable application. These include:
Server Side
- Apollo Datasource REST, Apollo Server, GraphQL Tools, Express, Redis and more.
Client Side
- Apollo Client, React, React Router, Redux Toolkit, Styled Components, etc.
Development Dependencies
- Babel, ESLint, Jest, TypeScript, Vite, among others.
Usage and Examples
- Explore: Navigate through the homepage, check our roadmap for upcoming plans.
- Get Started: Answer a couple of questions to receive plant suggestions.
- Learn More: Click on individual plants for detailed information.
Contribution Guidelines
We welcome contributions! To contribute, please:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
).
- Make your changes.
- Commit your changes (
git commit -am 'Add new feature'
).
- Push to the branch (
git push origin feature-branch
).
- Submit a Pull Request.
For questions, contact losterremotos101@gmail.com.
Contact and Support
For support or queries, reach out via email: losterremotos101@gmail.com.
Join our Discord Channel to connect with the team.
Acknowledgements and Credits
Special thanks to our founding contributors: