{"id":23398839,"url":"https://github.com/jsolly/geoasteroids","last_synced_at":"2025-04-11T17:25:21.394Z","repository":{"id":41433442,"uuid":"509139362","full_name":"jsolly/GeoAsteroids","owner":"jsolly","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-08T17:38:01.000Z","size":7988,"stargazers_count":4,"open_issues_count":12,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T00:46:49.874Z","etag":null,"topics":["asteroids","game","typescript"],"latest_commit_sha":null,"homepage":"https://www.geoasteroids.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsolly.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-06-30T15:42:34.000Z","updated_at":"2025-02-08T17:38:08.000Z","dependencies_parsed_at":"2024-03-22T09:30:41.149Z","dependency_job_id":null,"html_url":"https://github.com/jsolly/GeoAsteroids","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/jsolly%2FGeoAsteroids","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsolly%2FGeoAsteroids/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsolly%2FGeoAsteroids/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsolly%2FGeoAsteroids/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsolly","download_url":"https://codeload.github.com/jsolly/GeoAsteroids/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248448623,"owners_count":21105334,"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":["asteroids","game","typescript"],"created_at":"2024-12-22T09:49:36.547Z","updated_at":"2025-04-11T17:25:21.385Z","avatar_url":"https://github.com/jsolly.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GeoAsteroids\n[![GeoAsteroidsTest](https://github.com/jsolly/GeoAsteroids/actions/workflows/GeoAsteroidsTest.yml/badge.svg)](https://github.com/jsolly/GeoAsteroids/actions/workflows/GeoAsteroidsTest.yml)\n[![Coverage Status](https://coveralls.io/repos/github/jsolly/GeoAsteroids/badge.svg?branch=main)](https://coveralls.io/github/jsolly/GeoAsteroids?branch=main)\n[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)\n\nA 2D spaceship game, \u003ca href=\"https://geoasteroids.com\" target=\"_blank\" \u003eGeoasteroids.com\u003c/a\u003e\n\n![GeoAsteroids_playthrough (3)](https://user-images.githubusercontent.com/9572232/179308016-71265497-1d05-4750-bfd5-0f336cf7ae77.gif)\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Features](#features)\n- [Contributing](#contributing)\n- [Support](#support)\n- [License](#license)\n\n## Installation\n\n1 - (Install \u003ca href=\"https://nodejs.org/en/\" rel=\"noopener noreferrer\"\u003eNode.js\u003c/a\u003e\n2 - (Install \u003ca href=\"https://www.mongodb.com/try/download/community\" rel=\"noopener noreferrer\"\u003eMongoDB\u003c/a\u003e) (Or use a cloud service like \u003ca href=\"https://www.mongodb.com/cloud/atlas\" rel=\"noopener noreferrer\"\u003eMongoDB Atlas\u003c/a\u003e)\n\n```shell\n    $ git clone git@github.com:jsolly/GeoAsteroids.git\n    $ cd GeoAsteroids\n    $ npm install\n```\n\n## Setup\n\n```shell\n  $ cd \u003cmongoDB_install_dir\u003e/bin\n  # Start MongoDB Server Locally (Or use a cloud service like MongoDB Atlas)\n  $ ./mongod --dbpath \u003cpath to data directory\u003e\n  $ mongo # Or use a GUI like MongoDB Compass\n  $ use geoasteroids\n  $ db.createCollection(\"highscores\")\n  # Check src/database.ts for connection string\n  $ vercel dev # Allows us to mock serverless functions locally\n```\n\n---\n\n## Features\n\n#### Functional\n\n- Moving asteroids with variable jaggedness and size. Woah\n- Points, lives, and levels just like you'd expect\n- Spaceship with laser and thruster. Pew Pew\n- Global high scoreboard so you can compete with anyone in the world!\n\n#### Non-Functional\n\n- Asteroid collisions detection, so you die when you're supposed to\n- Static code analysis using CodeQL so the code is less likely to have security vulnerabilities\n- NPM Dependency checking via Dependabot so you don't have to think about it\n- 100% linted with Eslint + additional rules for a more maintainable and consistent codebase\n- TypeScript under 'strict' mode with no errors, so you know we're following TS best practices\n- JS bundling with Vite for a super fast front-end\n- Serverless functions for API calls, so you don't have to worry too much about handling the backend\n- MongoDB database for high scores cause who wants to deal with flat files?\n- Custom logging library for fine-grained control of logging levels so you don't have to scratch your head about errors in production\n- Over 90% test coverage so you can refactor and add features with peace of mind\n\n## Coverage, Tests, Linting\n\n### Coverage\n\n```shell\nnpm run coverage\n```\n\n### Test\n\n```shell\nnpm run test\n```\n\n### Linting (with ESlint)\n\n```shell\nnpm run lint\n```\n\n---\n\n## Contributing\n\nWant to work on this with me? DM me on Twiiter \u003ca href=\"https://twitter.com/_jsolly\" target=\"_blank\"\u003e`@_jsolly`\u003c/a\u003e\n\n### Step 1\n\n- **Option 1**\n\n  - 🍴 Fork this repo!\n\n- **Option 2**\n  - 👯 Clone to your local machine using `git@github.com:jsolly/GeoAsteroids.git`\n\n### Step 2\n\n- **HACK AWAY!** 🔨🔨🔨\n\n### Step 3\n\n- 🔃 Create a new pull request using \u003ca href=\"https://github.com/jsolly/GeoAsteroids/compare\" target=\"_blank\"\u003e`https://github.com/jsolly/GeoAsteroids/compare`\u003c/a\u003e.\n\n---\n\n\n## UML Diagram\n\n\u003cimg src=\"config/geoAsteroidsUML.png\" alt=\"GeoAsteroids UML diagram\"\u003e\u003c/img\u003e\n\n---\n\n## License\n\n[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)\n\n- **[MIT license](http://opensource.org/licenses/mit-license.php)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsolly%2Fgeoasteroids","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsolly%2Fgeoasteroids","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsolly%2Fgeoasteroids/lists"}