Hello! This project is dedicated to all cat parents who love to keep their furry friends safe while enjoying the beauty of indoor and outdoor plants.
This application provides a comprehensive list of plants, detailing which are safe and which are toxic for cats. It's a one-stop resource for ensuring the well-being of your feline companions in a plant-filled environment.
- Comprehensive Plant Database: The app includes a wide range of plants, from common houseplants to outdoor flora.
- Safety Status: Each plant is categorized as either safe or toxic for cats.
- Detailed Information: For each plant, we provide additional information such as its common names, scientific name, and a brief description.
- Search Functionality: Easily search for plants by their common or scientific names.
- User-Friendly Interface: The app is designed to be intuitive and easy to navigate.
The project adheres to a conventional Next.js application structure, with the src
directory housing the primary application code. Below is a quick rundown of the crucial directories and files:
src/pages
: This directory hosts the main pages of the application. The[[...slug]].tsx
file takes care of rendering plant details, while_app.tsx
and_document.tsx
are standard Next.js files used for customizing the application's HTML and root components.src/components
: This directory is home to the React components utilized across the application. Key components includePlantCard
,PlantDetails
,PlantFiche
,PlantGallery
,PlantSpecs
,PlantsFacade
,SafetyScore
, andSearch
.src/lib
: This directory houses theapi.ts
file, which is tasked with fetching data from the external API.src/utils
: This directory contains utility functions, includingflickr.tsx
for fetching photos from Flickr andusePhoto.tsx
for managing photo-related logic.package.json
: This file lists the project dependencies and scripts.
To get the application up and running locally, follow these steps:
- Clone the repository to your local machine.
- Navigate to the project directory.
- Install the project dependencies by running
npm install
. - Start the development server by running
npm run dev
.
The application should now be accessible at http://localhost:3000
.