Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skerwe/escape-boek-game-over

Escape Boek - Game Over: Inventory Companion
https://github.com/skerwe/escape-boek-game-over

choose-your-own-adventure cordova inventory mobile-app vue

Last synced: 2 days ago
JSON representation

Escape Boek - Game Over: Inventory Companion

Awesome Lists containing this project

README

        

# Escape Boek - Game Over: Inventory Companion

[![pages-build-deployment](https://github.com/Skerwe/escape-boek-game-over/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/Skerwe/escape-boek-game-over/actions/workflows/pages/pages-build-deployment)

```text
_____ _ _____ _
|_ _| | | / ____| (_)
| | _ ____ _____ _ __ | |_ ___ _ __ _ _ | | ___ _ __ ___ _ __ __ _ _ __ _ ___ _ __
| | | '_ \ \ / / _ \ '_ \| __/ _ \| '__| | | | | | / _ \| '_ ` _ \| '_ \ / _` | '_ \| |/ _ \| '_ \
_| |_| | | \ V / __/ | | | || (_) | | | |_| | | |___| (_) | | | | | | |_) | (_| | | | | | (_) | | | |
|_____|_| |_|\_/ \___|_| |_|\__\___/|_| \__, | \_____\___/|_| |_| |_| .__/ \__,_|_| |_|_|\___/|_| |_|
__/ | | |
|___/ |_|
```

> This is a digital inventory companion mobile application for the choose your own adventure game book.

## About

Save your progress by tracking your collected items and current location while playing through the [Escape boek - Game Over](https://www.de-leukste-kinderboeken.com/producten/escape-boek-game-over-9789000375080)

![Cover](https://www.de-leukste-kinderboeken.com/sites/default/files/covers/9789000375080.jpg)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Make sure these are installed first.

- [Node.js](http://nodejs.org)
- [npm](https://www.npmjs.com/get-npm) or equivilant
- [Cordova][cordova]
- [Java 11](https://adoptium.net/)

NOTE: You should install Apache Cordova globally, `npm install -g cordova`

### Quick Start

Clone the repository:

```shell
git clone https://github.com/Skerwe/escape-boek-game-over.git
```

Install the dependencies

1. In bash/terminal/command line, `cd` into the project directory.
2. Run `npm install` to install required files and dependencies.

Serve the documentation website on `localhost:3000`

```shell
docsify serve docs
```

## Build with

- [Vue 3](https://vuejs.org/) -- Progressive JavaScript Framework
- [Vue Router](https://router.vuejs.org/) -- The official router for Vue.js
- [Vite](https://vitejs.dev/) -- Vue Build Tool
- [Pinia](https://pinia.vuejs.org/) -- State Management
- [IDB-Keyval](https://github.com/jakearchibald/idb-keyval) -- IndexedDB Keyval Store
- [Bulma](https://bulma.io/) -- CSS Framework
- [Cordova][cordova] -- Cross-platform with One Code Base
- [i18next](https://www.i18next.com/) and [i18next-vue](https://github.com/i18next/i18next-vue) -- Internationalization Framework

[cordova]: https://cordova.apache.org/