Rick and Morty Wiki

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• ⭐️ Show your support
• 📝 License

📖 Rick and Morty Wiki

Rick and Morty Wiki is a fan made website that let's users get information on their favorite Tv show.

🛠 Built With

Tech Stack

• Next.js 13
• React.js
• Tailwind CSS
• Typescript
• StoryBook
• Class Variant Authority
• Next-SEO

Key Features

• Search for characters, episodes, and locations
• View Character details

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you will have these installed on your machine:

• Node.js
• git
• yarn

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:ma7moud3bas/rick-and-morty-wiki.git

Install

Install this project with:

  cd my-project
  yarn

Usage

To run the project in your local environment, execute the following command:

  yarn run dev

Run tests

currently only UI components are tested. to test them, run the following command:

  yarn run storybook

(back to top)

👥 Authors

👤 Mahmoud Abbas

• GitHub: @Ma7moud3bas
• LinkedIn: Mahmoud Abbas

(back to top)

⭐️ Show your support

If you like this project, show your support by giving it a star.

(back to top)

📝 License

This project is MIT licensed.

(back to top)