imsyntn / comic-info

Comic Info is a React-based web application that allows users to search and retrieve information about superheroes and villains from the Superhero API. This project provides an intuitive user interface to quickly access data about any character from the vast world of comics.

comic-info

Introduction

Comic Info is a user-friendly web application built with React, which harnesses the power of the Superhero API to provide detailed information about superheroes and villains. Whether you're a comic enthusiast, a casual fan, or just curious, Comic Info is your gateway to explore and learn about the fascinating world of comic characters.

Features

• Search for superheroes and villains by name.
• Display detailed information about each character, including their biography, power stats, appearance, and more.
• See an image of the character to visually identify them.
• User-friendly and responsive design for seamless browsing on desktop and mobile devices.

Getting Started

Follow these instructions to set up the project locally on your machine.

Prerequisites

• Node.js (at least version 12)
• npm (Node Package Manager) or yarn

Installation

1. Clone the repository:

git clone https://github.com/your-username/comic-info.git

2. Change into the project directory:

cd comic-info

3. Install dependencies

npm install

or

yarn install

Usage

1. Run the development server:

npm start

or

yarn start

2. Open your browser and go to http://localhost:3000 to access the application.

3. Enter the name of your favorite superhero or villain in the search box and click on the search button to retrieve their information.

Technologies

• React
• SuperHero API [https://superheroapi.com/]
• Sass

Contributing

Contributions are welcome! If you find any issues or want to add new features, feel free to open an issue or submit a pull request.

Please make sure to follow the Code of Conduct while contributing.

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). You can find the full text of the license here.

What does this license mean?

The CC BY-NC 4.0 license allows you to:

• Share — copy and redistribute the material in any medium or format.
• Adapt — remix, transform, and build upon the material.

Under the following terms:

• Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

• NonCommercial — You may not use the material for commercial purposes. For commercial use or inquiries, please contact [[email protected]].

How to give attribution?

When using or sharing this project, please provide proper attribution to the original creator. You can use the following format:

"comic-info" by [Sayantan Sarkar] is licensed under CC BY-NC 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-nc/4.0/legalcode].

Issues and Support

[[email protected]]

Acknowledgments

• Thanks to the creators and maintainers of the Superhero API for providing the data used in this project.
• The project utilizes icons from the React Icons library, making the UI more engaging and intuitive.
• Special thanks to Firebase for providing hosting services for this project, making it accessible to users.