kdurek / devchallenges-cat-wiki

Cat Wiki

Solution for a challenge from Devchallenges.io.

Demo | Solution | Challenge

Table of Contents

• Overview
  • User Stories
  • Built With
• Features
• How to use

Overview

User Stories

• I can search for cat breeds and select a breed of my choice
• I can see the most popular searched cat breeds summary on the homepage
• I can see the top 10 most searched cat breeds
• I can see the breed details including description, temperament, origin, life span, adaptability, affection level, child friendly, grooming, intelligence, health issues, social needs, stranger friendly
• I can see more photo of the breed
• On mobile, when I select the search option, a modal for breed search should pop up
• I can go to an article about cats when I click read more on Why you should have a cat section (optional)
• I can go to the top 10 cats by clicking see more in the dashboard (optional)

Built With

• NextJS
• Tailwind
• Firebase
• API

Features

This application/site was created as a submission to a DevChallenges challenge. The challenge was to build an application to complete the given user stories.

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/durashere/devchallenges-cat-wiki

# Install dependencies
$ npm install
$ yarn

# Run the app
$ npm run dev
yarn dev

firebase.js

NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=