GeoAsteroids

A 2D spaceship game, Geoasteroids.com

---

Table of Contents

• Installation
• Features
• Contributing
• Support
• License

Installation

1. (Install Node.js)
2. (Install MongoDB) (Or use a cloud service like MongoDB Atlas)

    $ git clone [email protected]:jsolly/GeoAsteroids.git
    $ cd GeoAsteroids
    $ npm install

Setup

  $ cd <mongoDB_install_dir>/bin
  # Start MongoDB Server Locally (Or use a cloud service like MongoDB Atlas)
  $ ./mongod --dbpath <path to data directory>
  $ mongo # Or use a GUI like MongoDB Compass
  $ use geoasteroids
  $ db.createCollection("highscores")
  # Check src/database.ts for connection string
  $ vercel dev # Allows us to mock serverless functions locally

Development

Multiplayer Development Setup

For local multiplayer development, use the following commands:

# Run all development servers (Vite + WebSocket)
npm run dev:full

# Run individual servers
npm run dev              # Vite dev server (port 5173)
npm run dev:multiplayer  # WebSocket server (port 3001)

Tests, Linting

Test

npm run test

Linting (with Biome)

npm run lint

• Biome is now configured using biome.jsonc for fast, reliable linting and formatting.
• The old ESLint configuration has been removed in favor of Biome's unified approach.
• To update rules or configuration, edit biome.jsonc.

---

Contributing

Want to work on this with me? DM me on X @_jsolly

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone to your local machine using [email protected]:jsolly/GeoAsteroids.git

Step 2

• HACK AWAY! 🔨🔨🔨

Step 3

• 🔃 Create a new pull request using https://github.com/jsolly/GeoAsteroids/compare.

---

UML Diagram

---

License

• MIT license