Bot Battlr

Description

This project is a web app named Bot Battlr,an application that fully uses React to create a feature that enables a user to select from a list of bots,and choose the bots that the user would like to fight for them based on the bots' stats. The app is created to satisfy a project for Moringa School.

Technologies Used

This project was bootstrapped with Create React App. Notable technologies used in this project include:

The JSON server is made accessible by hosting it using vercel, a hosting platform. The db.json is first placed in a seperate repository, in this case that repository is:

    https://github.com/Malcolm-G/bot-battlr-db-json

That repository is then deployed using vercel,which allows the db.json to act as an api with api methods like POST,DELETE and PATCH working. The api link is:

    https://bot-battlr-db-json.vercel.app/

and the data used in this app is found in the link below:

    https://bot-battlr-db-json.vercel.app/api/bots

Project Setup

Installation of application

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)
NPM

Installation of the application is not necessary but if one wishes to, the steps are described below. The installation steps are described for a linux machine.
To use this repo on your machine requires some simple steps

Alternative One (Cloning directly from my repository)

Open a terminal / command line interface on your computer

Clone the repo into your folder of choice by using the following:

  git clone https://github.com/Malcolm-G/bot-battlr-phase-2.git

Change directory to the repo folder:

  cd wk1-code-challenge-bank-of-flatiron

(Optional) Open it in Visual Studio Code
```
  code .
```
(Alternate Option) Open it in any editor of your choice.
Install the relevant dependencies by running the command:
```
  npm install
```

Alternative Two (Forking to your own repository)

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 use your username when cloning.

  git clone https://github.com/your-username-here/bot-battlr-phase-2.git

Running the application

If you wish to run application from cloned repository:

In the terminal run the command: npm start

If you wish to access the application without cloning it to your computer,simply follow this simple step:

Access the website by going to the following link:

          https://bot-battlr-phase-2-git-main-malcolm-g.vercel.app/

Authors

This project was contributed to by:

Malcolm Githuka

License

The project is under GNU GENERAL PUBLIC LICENSE Version 3

Malcolm-G / bot-battlr-phase-2