abnazhor/thomas-and-the-wolf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
API designed to play Thomas and the Wolf in Node.js with Express.
12 commits 2 branches 0 tags 103 KiB
  • JavaScript 100%
Find a file
Exact
Jorge fd0dcf6a6b
 Merge pull request #1 from abnazhor/add-license-1 
Create LICENSE
2021-10-28 19:54:31 +02:00
src Merge branch 'main' of https://github.com/abnazhor/thomas-and-the-wolf 2021-09-22 18:30:22 +02:00
test Update tests and add end of the game. 2021-09-22 18:30:10 +02:00
.gitignore First commit 2021-09-22 00:24:53 +02:00
.npmrc Add swagger file and update npmrc to force use of Node 14 2021-09-23 11:42:04 +02:00
LICENSE Create LICENSE 2021-10-28 19:54:04 +02:00
package-lock.json Add swagger file and update npmrc to force use of Node 14 2021-09-23 11:42:04 +02:00
package.json Add swagger file and update npmrc to force use of Node 14 2021-09-23 11:42:04 +02:00
pnpm-lock.yaml Add tests 2021-09-22 01:02:13 +02:00
README.md Add swagger file and update npmrc to force use of Node 14 2021-09-23 11:42:04 +02:00
swagger.json Fix /games/status route in swagger file 2021-09-23 11:43:58 +02:00

README.md


Thomas and the Wolf API

A simple API designed in Node.js with Express that allows you to play Thomas and the Wolf directly using queries to the server.

Report Bug . Request Feature

Downloads Contributors Issues License

Table Of Contents

Built With

  • Node.js
  • Express.js

Getting Started

Prerequisites

To use this application it is required to have the following dependencies installed:

  • npm
npm install npm@latest -g

Installation

  1. Clone the repo
git clone https://github.com/abnazhor/thomas-and-the-wolf.git
  1. Install NPM packages
npm install

Usage

To run the server, type

npm start

After executing this, application with automatically run over port 3000.

Testing

To test the API, type

npm run test

Future Improvements

Some things that could be done in a future version could be:

  • Add a mode that could deploy a web application done in any framework to display game interface easily.
  • Add support for multiple games at the same time for every session
  • Add achievements, counting the number of moves that the player does in every session.
  • Add more puzzles, as it is already supported but there is currently only one.