Skip to content

AilsonFreire/maze-game

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maze Game Solver

A TypeScript-based project that includes both a REST API server and an automated maze solver client. The project is split into two main components:

  • api/: A Node.js Express server that provides the maze game API endpoints
  • auto-run/: A TypeScript client that automatically solves the maze game using depth-first search algorithm

Features

  • RESTful API endpoints for maze game interactions
  • Automated maze solving with depth-first search algorithm
  • TypeScript implementation with proper type safety
  • Modern development setup with Yarn package manager
  • Clean and maintainable code structure

The maze sovle will:

  1. Connect to the API server
  2. Start a new game
  3. Solve the maze
  4. End the game

Development

Api Endpoints

The API server provides the following endpoints:

  • GET /game/start: Start a new game
  • DELETE /: Delete the game
  • GET /player: Get the player
  • PUT /player/move: Move to a new room
  • GET /room/current: Get the current room

Api Server

The API server is built with:

  • Node.js
  • Express
  • TypeScript

Auto-run Client

The auto-run client is built with:

  • TypeScript
  • Node.js

Project Structure

  • api/: Contains the REST API server
  • auto-run/: Contains the automated maze solver client

Prerequisites

  • Node.js (v18 or higher recommended)
  • Yarn package manager (v1.22.x)
  • TypeScript (v5.x)

Setup

  1. Start the API server:
yarn start:api
  1. Start the maze solver:
yarn start:run

#Future Improvements

  • Add unit tests

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors