It's Super! (Buggy)

This repository contains a simple Symfony application designed to assess developer skills. The code has intentional bugs and is designed in a way that lends itself towards refactoring.
Your challenge, should you choose to accept it, is to fix the list of known bugs described below. Should time allow, refactoring the codebase or adding new features is welcome. Please remember that this repository is a chance to show your problem-solving skills first and your OOP knowledge second. Please don't get bogged down on adding new features or overly ambitious refactors; it is more favourable to deliver a working solution on time then submitting an unfinished solution.

Application Feature

This Symfony application is the beginning of a fictional Superhero API used by a mobile app.

A previous developer started the project but has since moved on, leaving it unfinished.

At the moment, it provides a single endpoint that returns a specified superhero, their superpower, battle cry, power level, and comic-book/manga universe.

You can access the endpoint by running the following command in your terminal:

curl http://localhost:8000/super-hero/data

Known Bugs

1. When passing in a hero query string parameter, the application returns a 500 error or a random hero.
2. The response is meant to return a JSON object, but at the moment, it returns a string representing the data.
3. When the hero Vegeta is returned, the application returns a 500 error.

Project Structure

The project directory structure is as follows:

app/               # Application source code
bin/               # Contains the console commands to help you run the application
docker/            # Contains the docker configuration files

Useful Staring Points

1. The application is built using the latest LTS version of Symfony v6.4. Documentation can be found here.
2. The controller for the problematic endpoint is located here

Submission Instructions

1. Clone this repository.
2. Fix the known bugs.
3. Submit your solution as a pull request to this repository.
4. Include a brief description of the bugs you fixed, the refactorings you made, and any new features you added.
5. Include any instructions on how to run your solution if relevant
6. The team will review the pull request, and feedback will be provided.

Bonus Points

1. Refactor the codebase as you see fit.
2. Add any new features you think would be useful.

Installation Requirements

Docker and Docker Compose are required to run this project. If you don't have them installed, you can download them from the following links:

• Docker
• Docker Compose

Running the Project

To run the project, you need to execute the following commands:

docker-compose up --build -d

After running the command, you can access the project at the following URL: http://localhost:8000

You should see the default Symfony welcome page.

You may need to wait a short while for the application to finish downloading and installing requirements.

You can inspect the application container to see if it's ready by running the following command:

docker-compose logs -f app

This will show you the logs of the application container. You should see a message like the following when the application is ready:

app-1  | [05-Sep-2024 19:57:00] NOTICE: ready to handle connections

Helpful Commands

To save time, you can run the following command to boot the application and automatically open it in your default browser when it's ready:

bin/boot