Welcome to the world of SonarQuest, where code quality meets gamification! With SonarQuest, developers can tackle their code quality issues through quests and adventures, earning rewards along the way. Ready to embark on this journey? Let’s get started!
Quick Start: Installing SonarQuest
Follow these simple steps to kick off your adventure using Docker:
- Clone this repository to your desired destination.
- Navigate to the root project folder sonarquest and run the following command:
docker-compose up
This command will install the latest Docker images.
- We’ve added some initial users for you to experiment with. Open SonarQuest by visiting http://localhost:4200 and log in with the following credentials:
Role | Username | Password |
---|---|---|
Admin | admin | test |
Game Master | gm | test |
Developer (Player) | dev | test |
If you prefer not to use Docker, check out the Installation Guide in our wiki!
Starting Your Game
Once you’re logged in, follow these steps to start the game:
- Log in as Admin.
- Connect to any reachable SonarQube server and check the connection.
- Import all projects from SonarQube into SonarQuest, making one project playable as a world.
- Assign a Game Master and players to this world.
- Log in as the predefined Game Master or create a new one.
- Gather all issues (tasks) for the current world.
- Create quests by writing a short story and adding tasks to make them solvable.
- Optionally, create an adventure to support a whole story with multiple quests.
- Have your players log in (all pre-made avatars have the password test and their username as login) and take on quests by selecting to fight issues.
- Occasionally log in as Game Master to synchronize SonarQuest with the SonarQube project for player rewards!
Have fun on your journey!
Understanding SonarQuest: An Analogy
Think of SonarQuest as a magical castle where every room represents a different aspect of code quality. When you journey through this castle, you discover various quests (or challenges) that need to be tackled. Each quest helps you clean up that particular room, which may be messy due to code smells and optimization issues. As you solve these quests, you earn rewards, just like collecting treasures in a game. Your mission is to ensure the entire castle (your codebase) is splendid and free from clutter!
Troubleshooting
Having trouble? Here are some troubleshooting ideas:
- If you cannot connect to the SonarQube server, double-check your connection settings and ensure the server is reachable.
- If you face issues running Docker, make sure you have the latest version installed.
- For error messages, refer to the console logs for specific troubleshooting information.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Conclusion
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.