{"id":13763942,"url":"https://github.com/mguinea/js13k-aframe-boilerplate","last_synced_at":"2025-04-12T03:24:50.273Z","repository":{"id":43486601,"uuid":"194737103","full_name":"mguinea/js13k-aframe-boilerplate","owner":"mguinea","description":"An A-Frame boilerplate for the js13k competition. http://js13kgames.com/","archived":false,"fork":false,"pushed_at":"2023-03-01T10:31:16.000Z","size":727,"stargazers_count":13,"open_issues_count":11,"forks_count":5,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-25T23:01:46.058Z","etag":null,"topics":["a-frame","boilerplate","html5","js13k","js13kgames","webpack"],"latest_commit_sha":null,"homepage":null,"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/mguinea.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-07-01T20:14:42.000Z","updated_at":"2024-03-07T07:32:03.000Z","dependencies_parsed_at":"2024-08-03T15:02:51.746Z","dependency_job_id":"cf9dd83f-0dca-4b67-8b27-3ec41fcef9b8","html_url":"https://github.com/mguinea/js13k-aframe-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mguinea%2Fjs13k-aframe-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mguinea%2Fjs13k-aframe-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mguinea%2Fjs13k-aframe-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mguinea%2Fjs13k-aframe-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mguinea","download_url":"https://codeload.github.com/mguinea/js13k-aframe-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248511092,"owners_count":21116353,"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":["a-frame","boilerplate","html5","js13k","js13kgames","webpack"],"created_at":"2024-08-03T15:01:02.280Z","updated_at":"2025-04-12T03:24:50.249Z","avatar_url":"https://github.com/mguinea.png","language":"JavaScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"![js13k logo](./js13k-logo.png) \n\n# JS13K A-Frame Boilerplate\n\nThis project is a boilerplate to start developing a WebXR game based on [A-Frame](https://aframe.io/) and [Webpack](https://webpack.js.org/) for the [js13k competition](https://2019.js13kgames.com/).\n\n\n![A-Frame logo](./a-frame.png)\n\n## Getting Started\n\n### Prerequisites\n\n- You need [node](https://nodejs.org/en/download/current/) installed.\n\n### Installing\n\n- Clone this repository\n- Update `package.json` with your info\n- Delete `.git` directory\n- Delete unneeded files and blocks\n- Download node dependencies\n\n```bash\nnpm install\n```\n\n### Start development server\n\nAfter installation you just need to run:\n\n```bash\nnpm start\n```\n\nThis will setup a server listening at `http://localhost:8080/`.\n\nIf everything went OK, you will see:\n\n![Screenshot](./screenshot.png)\n\n#### Access from another device\n\nYou can pass an argument to the development server specifying the interface to listen on.\n\n```bash\nnpm start -- --host=0.0.0.0\n```\n\nThis command will start the development server listening on all interfaces. Having a device on the same network you will be able to view the webpage at `http://[yourLocalIP]:8080` for example `http://192.168.1.1:8080`.\n\n## Build for submission\n\nThis project provides a npm script for building your application\n\n```bash\nnpm run build\n```\n\nThis will generate two files index.html and build.zip both located in the dist/ folder. The zip file contains only the generated index.html. The output from the command also tells you how large is the generated zip file.\n\n## Where does my code go?\n\nAll your javascript files should be located in the `src/app/` directory. The entry point is the `main.js` file. All your css should be located in the `src/styles` directory. The entry point is `main.css`. If you need to modify the html file, you can find the template used in `src/index.html`.\n\nThis project uses webpack for module bundling. This means that all the files that you want to use should be imported directly or indirectly by either `main.js` or `main.css`.\n\n## ES2015+ support\n\nThis repository used to include [Babel](https://babeljs.io/) to enable working with modern JavaScript. As time progresses however the browser support for modern JS became excelent and webpack began shipping a newer version of uglify that can minify it. All of this makes it a rational choice to omit Babel as it would only increase the overall bundle size.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n## References\n\n* This project is based on [https://github.com/sz-piotr/js13k-webpack-starter](https://github.com/sz-piotr/js13k-webpack-starter) by Piotr Szlachciak.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmguinea%2Fjs13k-aframe-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmguinea%2Fjs13k-aframe-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmguinea%2Fjs13k-aframe-boilerplate/lists"}