https://github.com/fernando-gimeno/cat-wiki

https://github.com/fernando-gimeno/cat-wiki

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fernando-gimeno/cat-wiki
• Owner: fernando-gimeno
• Created: 2023-07-27T14:37:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-10T19:50:33.000Z (6 months ago)
• Last Synced: 2024-07-10T23:26:04.587Z (6 months ago)
• Language: TypeScript
• Homepage: https://cat-wiki-inky-ten.vercel.app
• Size: 2.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Cat Wiki




   Solution for a challenge from  Devchallenges.io.





  


    

      Demo

    

     | 

    

      Solution

    

     | 

    

      Challenge

    

  



## Table of Contents

- [Overview](#overview)

  - [Built With](#built-with)

- [Features](#features)

- [How to use](#how-to-use)

- [Contact](#contact)

- [Acknowledgements](#acknowledgements)

## Overview

![screenshot](https://i.imgur.com/m8CSv6G.png)

"Cat wiki" is a repository of cat breeds where we can see the different characteristics of each breed.

### Built With

- [React](https://react.dev/)

- [Next.js](https://nextjs.org/)

- [TypeScript](https://typescriptlang.org/)

- [Tailwind](https://tailwindcss.com/)

## Features

This application/site was created as a submission to a [DevChallenges](https://devchallenges.io/challenges) challenge. The [challenge](https://devchallenges.io/challenges/f4NJ53rcfgrP6sBMD2jt) was to build an application to complete the given user stories.

## How To Use

To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash

# Clone this repository

$ git clone https://github.com/fernandouy/cat-wiki.git

# Install dependencies

$ npm install

```

### Edit .env.template

Rename .env.template to .env and modify the API key for your own API Key from [The Cat API](https://thecatapi.com)

Then execute

```bash

# Start project

$ npm start

```

## Acknowledgements

- [Steps to replicate a design with only HTML and CSS](https://devchallenges-blogs.web.app/how-to-replicate-design/)

- [Node.js](https://nodejs.org/)

- [HeadlessUI](https://headlessui.com/)

- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)

## Contact

- Website [fernandouy.github.com](https://fernandouy.github.io/)

- GitHub [@fernandouy](https://github.com/fernandouy/)