https://github.com/calvitoria/marvel_comics
This Rails project uses the Marvel API to display character data and other related information. The frontend is styled with Tailwind CSS, and the app is primarily tested using RSpec.
https://github.com/calvitoria/marvel_comics
marvel marvelapi marvelapp rails redis ruby tailwindcss
Last synced: 2 months ago
JSON representation
This Rails project uses the Marvel API to display character data and other related information. The frontend is styled with Tailwind CSS, and the app is primarily tested using RSpec.
- Host: GitHub
- URL: https://github.com/calvitoria/marvel_comics
- Owner: calvitoria
- Created: 2024-11-29T13:47:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T09:57:59.000Z (over 1 year ago)
- Last Synced: 2025-01-19T23:56:49.242Z (over 1 year ago)
- Topics: marvel, marvelapi, marvelapp, rails, redis, ruby, tailwindcss
- Language: Ruby
- Homepage:
- Size: 343 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Marvel Comics App 🦸🏼🧾
This Rails project uses the Marvel API to display character data and other related information. The frontend is styled with Tailwind CSS, and the app is primarily tested using RSpec.
The app allows you to search for your favorite Marvel character (like Hulk, for example) and then get a random story that they appear in. Once you search, the app shows the story’s description, lists the names and pictures of the characters featured in the story. At the bottom of every page, you can also find the required Marvel attribution text. `(Data provided by Marvel. © 2024 MARVEL)`
In short, this was a great way to enhance my Ruby on Rails skills and also get to know more stories and characters in the Marvel universe!
## Table of Contents
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Configuration](#configuration)
- [Running the Application](#running-the-application)
- [Running Tests](#running-tests)
## Prerequisites
Ensure you have the following installed before setting up the project:
- Ruby 3.3.5
- Rails 8.0.0
- Redis
## Setup
To set up the project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/calvitoria/marvel_comics
cd marvel_comics
```
2. You can use the `make` command to automate setup, configuration, and running the app:
```bash
make setup
```
Alternatively, you can manually set up and configure the project with the following steps:
```bash
# Install required gems
bundle install
# Run redis
redis-server
# Precompile assets
bin/rails assets:precompile
```
## Configuration
To configure the project, you will need to set up the necessary environment variables:
1. Create and populate the `.env` file with your Marvel API credentials and other required settings.
2. You can use the `make` command to automate this step:
```bash
make config
```
Or manually configure credentials with the following command:
```bash
bin/credentials_config
```
## Running the Application
To start the application locally, run:
```bash
rails server
```
## Running Tests
To run the tests using RSpec:
```bash
rspec
```
I am open to any feedback and collaboration! Feel free to reach out if you'd like to contribute or share suggestions.