/Bot-Battlr-Code-Challenge

Primary LanguageJavaScript

React + Vite

Bot-Battlr-Code-Challenge

Bot Management System

Overview

This is a simple React application that allows you to manage a collection of bots. You can view a collection of all available bots, add them to your bot army, and remove them from your army. Additionally, you can delete bots from the collection entirely.

Table of Contents

  1. Prerequisites
  2. Getting Started
  3. Application Structure
  4. How to Use
  5. Contributing
  6. License

Prerequisites

Before you can run this application, you need to have the following software installed on your system:

Node.js npm (Node Package Manager)

Getting Started

To get started with the Bot Management System, follow these steps:

  1. Clone the repository to your local machine. shell: git clone
  2. Navigate to the project folder. shell: cd bot-battlr-code-challenge
  3. Install the project dependencies. shell: npm install
  4. Start the development server. shell: npm start
  5. Open your web browser and go to http://localhost:5173/ to access the application. The base URL for your backend is: http://localhost:3000

Application Structure

The application is structured as follows:

src/components - Contains React components used to build the application. src/App.js - The main application component that brings everything together. src/index.js - Entry point of the application.

Languages used

  1. REACT JAVASCRIPT
  2. JSON SERVER
  3. CSS

How to Use

View Bot Collection: You can view a collection of all available bots on the main page. Add Bots to Your Bot Army: Click on a bot's card in the collection to add it to your bot army. You can only add each bot once to your army. View Your Bot Army: Click the "Bot Army" button to view the bots in your army. Remove Bots from Your Bot Army: In your bot army, you can remove bots from your army. Delete Bots: You can delete bots from the collection entirely.

Author

Name: Evans Kurgat Email: evancherry254@gmail.com

Contributing

If you'd like to contribute to this project, please follow these steps:

  1. Fork the project on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your fork.
  5. Create a pull request on the original repository.
  6. Please make sure your code follows best practices and includes appropriate documentation.