{"id":16674294,"url":"https://github.com/wol-soft/beerplop","last_synced_at":"2025-03-17T00:32:02.863Z","repository":{"id":37587968,"uuid":"190578396","full_name":"wol-soft/beerplop","owner":"wol-soft","description":"Repository for the incremental game Beerplop","archived":false,"fork":false,"pushed_at":"2024-08-15T08:33:56.000Z","size":3359,"stargazers_count":23,"open_issues_count":21,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-13T12:30:11.845Z","etag":null,"topics":["docker","docker-compose","idle","idle-clicker-game","idle-game","incremental","incremental-game","javascript","php"],"latest_commit_sha":null,"homepage":"https://wol-soft.de/apps/beerplop/plop","language":"JavaScript","has_issues":true,"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/wol-soft.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":"2019-06-06T12:34:59.000Z","updated_at":"2024-08-15T08:34:00.000Z","dependencies_parsed_at":"2024-08-15T10:12:48.163Z","dependency_job_id":null,"html_url":"https://github.com/wol-soft/beerplop","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wol-soft%2Fbeerplop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wol-soft%2Fbeerplop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wol-soft%2Fbeerplop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wol-soft%2Fbeerplop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wol-soft","download_url":"https://codeload.github.com/wol-soft/beerplop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221669313,"owners_count":16860852,"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":["docker","docker-compose","idle","idle-clicker-game","idle-game","incremental","incremental-game","javascript","php"],"created_at":"2024-10-12T12:30:09.295Z","updated_at":"2024-10-27T11:35:13.293Z","avatar_url":"https://github.com/wol-soft.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://wol-soft.de/apps/beerplop/plop\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Beerplop\" width=\"100\" src=\"https://raw.githubusercontent.com/wol-soft/beerplop/master/src/View/Img/main-beer.svg?sanitize=true\"\u003e\n  \u003c/a\u003e\n\n  [![](https://github.com/wol-soft/beerplop/workflows/CI/badge.svg)](https://github.com/wol-soft/beerplop/actions)\n\u003c/p\u003e\n\n# Beerplop\n\nRepository for the incremental game Beerplop.\n\nIf you encounter a bug, have a feature request or an idea for an improvement just open an issue or start contributing to Beerplop.\n\nSome links:\n\n- [Beerplop game](https://wol-soft.de/apps/beerplop/plop)\n- [Beerplop wiki](https://wol-soft.de/apps/beerplop/wiki)\n\nHappy coding, Cheers!\n\n## Development\n\nTo have a running Beerplop instance ready to develop execute the following steps:\n\n* clone the repository\n* switch to the root directory of the project\n* run `docker-compose up --build` (installation: https://docs.docker.com/compose/install/)\n\nDuring the first start up some containers may throw errors because not all required dependencies are yet available. They will continue to restart until the containers which install the dependencies are finished (beerplop-grunt, beerplop-composer).\nTo check if everything is finished switch to a second terminal and execute `docker ps`. You should see six running containers (Status **Up**):\n\nContainer name | Exposed port | Purpose\n--- | --- | ---\nbeerplop-grunt | | (Re-)building client side components\nbeerplop-node | 8081 | Providing NodeJS server for socket connections (eg. lobby)\nbeerplop-apache | 8080 | Providing the apache webserver to handle HTTP requests\nbeerplop-php | | PHP-FPM to execute PHP scripts\nbeerplop-mysql | 8082 | Database for users, save states etc.\nbeerplop-redis | 8083 | Backend caching\n**Containers used on start up:** | | \nbeerplop-composer | | install dependencies\n\nBeerplop is now available at http://localhost:8080\n\nTo develop simply modify files, the directory you cloned the project into is linked with the docker container. If you change scripts, styles or images the application will be rebuild in the `beerplop-grunt` container automatically. Simply refresh the page to see your changes.\n\nSome technical stuff is documented in the [wiki](https://wol-soft.de/apps/beerplop/wiki) at *Technical stuff*\n\n### Tests\n\nTo execute the tests in your browser visit http://localhost:8080/test after all containers are started. Alternatively you can execute `node tests\\bootstrap.js` (either in a container or from your host system, then requires installed NodeJS; additionally you may have to trigger chromium download via `npm install puppeteer` manually even if the dependencies from the package.json were installed). Currently the tests load a Beerplop page in the background and afterwards operate on the DOM.\n\n### Recover\n\nIf something breaks completely, shutdown your containers, clear everything with `docker system prune -af \u0026\u0026 docker volume prune -f`, clear your locally fetched dependencies (directories `vendor` and `node_modules`) and rebuild the application with `docker-compose up --build`.\n\n## Contribute\n\nContributions are welcome! Help to discuss or fix open [issues](https://github.com/wol-soft/beerplop/issues) or develop your own ideas to bring more content into Beerplop or to improve the current gameplay.\nIncrease the code quality by refactoring code or adding more tests.\n\nPlease provide a short description of your changes in the changelog file at `src/Changelog.txt`.\n\nIf you plan to develop a large new feature or to change fundamental elements/mechanics please open an issue before to discuss the change.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwol-soft%2Fbeerplop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwol-soft%2Fbeerplop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwol-soft%2Fbeerplop/lists"}