BOT BATTLR

Description

This is an application that allows users to browse through a list of robots, view a robot's details, and enlist a bot into their army.

Author

• Mercy Saina

Live link

• click to open application

Features

• On load of the page, the bots collection will be displayed.

Sort by bot class

• Select class option from drop-down menu provided on bot colletion section to display bots that belong to the selected class.

Add bot to your army

• Click on the bot of your choice on the collection list to add a bot to your army upto a maximum of six bots. NOTE: Each bot belongs to a specific class, you can only list one bot from each class.

Discharge bot from your army

• Click on the discharge button on the bot you want to discharge from your army. This will enlist the bot back to the bot collection and remove it from your army.

Delete bot from your army

• Click on the delete button on the bot you want to delete from your army. This will remove the bot from both the bot collection and your army list.

Development installation

Requirements

In order for you to use the content on this repo ensure you have the following:

• A computer that runs on either of the following; (Windows 7+, Linux, Mac OS).
• nodejs 9.0+
• Visual Studio Code.
• Live server extension.

Alternative One

• Open a terminal / command line interface on your computer.

• Clone the repo by using the following to create a copy on your local machine:

    git clone https://github.com/sainamercy/Bot-Battlr
  

• Change directory to the repo folder:

    cd Bot-Battlr
  

• Open it in Visual Studio Code

    code .
  

Alternative Two

• On the top right corner of this page there is a button labelled Fork.

• Click on that button to fork the repo to your own account.

• Take on the process in Alternative One above.

• Remember to replace your username when cloning.

    git clone https://github.com/your-username-here/Bot-Battlr
  

Running the application

To run the application, you can use the following steps to run the app.

• Run npm install to install required dependancies.

    npm install
  

• Run npm run dev then follow the link provided to open the application on your browser.

    npm run dev
  

• Repeat the steps on the Features section above.

License

• The project is licensed by ISC.