/marvelous

A Comic List web app that consumes the Marvel Comics' API

Primary LanguageRuby

logo

Marvelous Web App

📗 Table of Contents

📖 Marvelous

Marvelous is a web app that allows users to search for Marvel characters and comics. It uses the Marvel API to fetch data and display it to the user. The app is built with Ruby on Rails

🛠 Built With

Tech Stack

Client
  • TailwindCSS
  • Hotwire Turbo
  • Hotwire Stimulus
Server
  • Ruby on Rails

Key Features

  • Fetches up-to-date data from Marvel API
  • HTML over-the-wire with Turbo
  • Allows searching for a speciic comic

(back to top)

🚀 Live Demo

  • TBA

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  • Ruby installed in your machine

Setup

Clone this repository to your desired folder:

  git clone git@github.com:rskinnerc/marvelous.git

Install

Install this project with:

  cd marvelous
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

Deployment

You can deploy this project using your favorite service

(back to top)

👥 Authors

👤 Ronald SKinner

(back to top)

🔭 Future Features

  • Implement liking comics
  • Add authentication
  • Implement comments per comic

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Kelvin for his time mentoring me through this project.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)