Skip to content

potts92/warehouse-robot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Warehouse Robot

Getting Started

Pre-Requisites

  • Node installed on your system

Installation

  1. npm install

Usage

Run tests

Run jest tests with: npm run test

Run the application

  1. npm run start
  2. Follow the on-screen prompts to input values for warehouse and robot creation to set up the scenario
  3. Follow the on-screen prompts to provide commands to the robot to move it around the warehouse

Features

  • Utilises the inquirer package to provide a command line interface for the user to input values for the warehouse and robot creation, and to provide commands to the robot to move it around the warehouse.
  • Scenario class to handle the creation of the CLI interface to setup both the warehouse and robot as well as moving the robot around the warehouse
  • Warehouse class to handle the creation of the warehouse
    • Generates a UUID to identify the warehouse to allow for potential future expansion to handle multiple warehouses
    • Stores its width and height and allows public access to these values via getters
    • Stores the locations of crates in the warehouse (with stringified coordinates as keys for easy collision detection)
  • Robot class to handle the creation of the robot and to provide methods to move the robot around the warehouse and grab and drop crates. Errors if the robot is moved or installed outside the warehouse bounds
    • Generates a UUID to identify the warehouse to allow for potential future expansion to handle multiple robots
    • Stores its current location in terms of x and y coordinates
    • Stores its warehouse's width and height
    • Stores the crate it is currently holding
    • Publicly reports its current location
    • Capable of grabbing, moving and dropping crates
  • Crate class to handle the creation of crates
    • Generates a UUID to identify the warehouse to allow for potential future expansion to handle multiple crates
    • Stores its current location in terms of x and y coordinates

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •