10-menachi / anime-facts

Anime Facts

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 🚀 Live Video
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 To Do List

Anime Facts is a web application that allows users to view facts and details about their favorite anime shows.

🛠 Built With

Tech Stack

Client

• React JS

Server

No server-side technologies were used for this project.

Database

No database was used for this project.

Key Features

• View Anime Facts
• View Anime Details

(back to top)

🚀 Live Demo

Live Demo

(back to top)

🚀 Live Video

Live Video

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Stylelint
• ESLint
• Node JS
• Node package Manager (NPM) OR Yarn
• react-icons

Install

Follow the link below to install Node JS

• Node JS

Follow the link below to install NPM

• NPM

Follow the link below to install Yarn

• Yarn

Once you have installed Node JS and NPM or Yarn, install the following packages globally:

  npm install -g stylelint
  npm install -g eslint
  npm install react-icons

OR if on Yarn,

  yarn global add stylelint
  yarn global add eslint
  yarn add react-icons

However, whilst everything is included in the package.json file, you can simply run:

  npm install

OR if on Yarn,

  yarn install

Don't know how to use Package Managers? Check out the Beginner's Guide

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/10-menachi/anime-facts.git

Usage

To run the project:

  cd anime-facts
  npm run start

OR if on Yarn,

  cd anime-facts
  yarn start

The website is hosted on localhost:5173 by default.

To change the port to the port of your choice, run:

  npm run start --port=YOUR_PORT

Wanna learn more about React? Check out the React Documentation Wanna learn more about Vite? Check out the Vite Documentation

Run tests

To run the tests:

  npm run test

OR if on Yarn,

  yarn test

(back to top)

👥 Authors

👤 Christian Wamalwa

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• User Authentication
• Edit Anime
• Update Anime Watching Progress
• View Anime comments

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this opportunity to learn and build this project.

I would also like to acknowledge Nelson Sakwa, the author of This Design

(back to top)

📝 License

This project is MIT licensed.

(back to top)