InternetEnemies / combatcritters-ts

TypeScript wrapper for CombatCritters APi
0 stars 0 forks source link

Combat Critters Typescript

This is a wrapper for the CombatCritters API.

This repository is mainly used as an interface by the react frontend.

Getting Started

Prerequisites

Ensure you have the following software installed on your system:

  1. Node.js (version >= 16.x.x) and npm
    • Download and install Node.js from here.
  2. Git for version control
    • Install Git from here.

Setup

1. Clone the Frontend Repository

First, clone the frontend repository to your local machine:

git https://github.com/InternetEnemies/combatcritters-ts.git

Navigate into the project directory:

cd combatcritters-ts

2. Install Dependencies

Run the following command to install the necessary npm packages:

npm install

Running Integration Tests

1. Set Environment

  1. Docker
    • Download and install Docker from here.
  2. WebStorm
    • Download and install WebStorm from here.

2. Open Docker

Open Docker and ensure that it is running.

3. Run Integration Tests

Run the integration tests in test/integration using WebStorm

Click the green play button next to the test file you want to run.