{"id":23507179,"url":"https://github.com/ngljcb/px-interactive-story","last_synced_at":"2025-06-11T23:39:38.583Z","repository":{"id":268410507,"uuid":"883325229","full_name":"ngljcb/px-interactive-story","owner":"ngljcb","description":"Spring Boot app with Firebase, featuring an interactive story, developed with programming principles, SOLID, \u0026 design patterns for Software Engineering","archived":false,"fork":false,"pushed_at":"2025-01-02T08:48:22.000Z","size":68065,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T06:13:22.022Z","etag":null,"topics":["design-patterns","firebase-auth","firebase-database","interactive-story-game","software-engineering","solid-principles","spring-boot","unibo","university-project"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ngljcb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-04T19:09:49.000Z","updated_at":"2025-01-31T18:59:29.000Z","dependencies_parsed_at":"2024-12-16T15:59:43.008Z","dependency_job_id":"9a7eb583-38cd-4244-bb92-cad742cc9015","html_url":"https://github.com/ngljcb/px-interactive-story","commit_stats":null,"previous_names":["ngljcb/interactivestory"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngljcb%2Fpx-interactive-story","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngljcb%2Fpx-interactive-story/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngljcb%2Fpx-interactive-story/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngljcb%2Fpx-interactive-story/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ngljcb","download_url":"https://codeload.github.com/ngljcb/px-interactive-story/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239180277,"owners_count":19595599,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design-patterns","firebase-auth","firebase-database","interactive-story-game","software-engineering","solid-principles","spring-boot","unibo","university-project"],"created_at":"2024-12-25T10:14:49.774Z","updated_at":"2025-02-16T19:14:23.065Z","avatar_url":"https://github.com/ngljcb.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Interactive Story\n\n\u003ca href=\"#\"\u003e\u003cimg src=\"./app/assets/banner.gif\"\u003e\u003c/a\u003e\n\n## Introduction\n\nThe **Interactive Story** is a web app developed as Software Engineering course's final project, adhering to core **Object-Oriented Programming (OOP)** principles, **SOLID** principles, and implementing various **design patterns** for scalability and maintainability. The game is an engaging platform where users can immerse themselves in interactive stories, make choices, and explore different outcomes.\n\nThis project is built with a focus on clean architecture, modularity, and a separation of concerns, ensuring a robust and extensible codebase.\n\n## How the Game Works\n\nThe game offers players a dynamic storytelling experience:\n\n1. **Interactive Story Selection**:\n   Players can browse through a catalog of stories, each represented by a brief description and title.\n\n2. **Gameplay Mechanics**:\n\n   - Each story is broken down into scenarios.\n   - Players make choices, answer riddles, or provide items to progress.\n   - Based on the choices, the story branches into different paths.\n\n3. **Dynamic Scenarios**:\n\n   - Scenarios may include challenges such as riddles or specific item requirements.\n   - The game adapts based on the player's inventory and responses.\n\n4. **Endgame**:\n   - Stories conclude when all scenarios are completed or when players reach specific final outcomes.\n\n## How to Play\n\n1. **Browse Stories**:\n\n   - Visit the homepage to view available stories.\n   - Click \"Gioca ora\" to start a story (login required).\n\n2. **Make Choices**:\n\n   - Follow the prompts, make decisions, and progress through the story.\n\n3. **Endgame**:\n   - Complete the story or explore multiple endings based on your choices.\n\n## Technologies Used\n\nThe project integrates modern technologies for both frontend and backend:\n\n### Frontend:\n\n- **HTML5**, **CSS3**, and **JavaScript**: For responsive and interactive user interfaces.\n- **Firebase Authentication**: User login and registration.\n- **Dynamic Rendering**: Scenarios, choices, and outcomes are dynamically displayed based on backend responses.\n\n### Backend:\n\n- **Spring Boot**:\n  - RESTful APIs to handle game logic and interactions.\n  - Session management for user state tracking.\n- **Firebase Firestore**:\n  - Database for storing stories, scenarios, and user progress.\n- **Java**:\n  - Backend language adhering to OOP principles.\n  - Controllers and services handle requests and game logic.\n\n## Installation and Setup\n\n### Prerequisites\n\n- **Java JDK 21+**\n- **Maven** (for building the backend)\n- **Firebase**: Set up Firebase Project\n\n### Steps to Install\n\n1. **Clone the Repository**:\n\n   ```bash\n   git clone https://github.com/ngljcb/px-interactive-story.git\n   ```\n\n2. **Initial Setup**:\n\n   - Navigate to the `resources` folder:\n     ```bash\n     cd /src/main/resources/\n     ```\n   - Configure `google-services.json` for Firebase:\n     ```properties\n     {\n        \"type\": \"xxxxx\",\n        \"project_id\": \"xxxxx\",\n        \"private_key_id\": \"xxxxx\",\n        \"private_key\": \"xxxxx\",\n        \"client_email\": \"xxxxx\",\n        \"client_id\": \"xxxxx\",\n        \"auth_uri\": \"xxxxx\",\n        \"token_uri\": \"xxxxx\",\n        \"auth_provider_x509_cert_url\": \"xxxxx\",\n        \"client_x509_cert_url\": \"xxxxx\",\n        \"universe_domain\": \"xxxxx\"\n     }\n     ```\n\n3. **Build and run**:\n\n   - Install dependencies (if applicable):\n     ```bash\n     mvn clean install\n     ```\n   - Run the app:\n     ```bash\n     mvn spring-boot:run\n     ```\n\n4. **Access the Game**:\n   - Open your browser and navigate to `http://localhost:8080` for the game interface.\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngljcb%2Fpx-interactive-story","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fngljcb%2Fpx-interactive-story","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngljcb%2Fpx-interactive-story/lists"}