https://github.com/questnetwork/quest-engine-js

Allows to create, join and participate in quests on the network.
https://github.com/questnetwork/quest-engine-js

quest-engine

Last synced: 5 months ago
JSON representation

Allows to create, join and participate in quests on the network.

• Host: GitHub
• URL: https://github.com/questnetwork/quest-engine-js
• Owner: QuestNetwork
• License: agpl-3.0
• Created: 2020-09-30T23:36:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-20T12:15:11.000Z (over 5 years ago)
• Last Synced: 2025-02-08T17:30:41.075Z (over 1 year ago)
• Topics: quest-engine
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Completion 2.4.0](https://img.shields.io/badge/completion%20v1.0.0-2%25-red) ![Help Wanted](https://img.shields.io/badge/%20-help--wanted-%23159818) ![Version 0.9.3](https://img.shields.io/badge/version-v1.0.0-blue) ![Sponsors](https://img.shields.io/badge/sponsors-0-red)

## Quest Engine

## Description

An Angular compatible NodeJS library for the use with [qOS](https://github.com/QuestNetwork/quest-os-js) that allows to create and participate in quests on the network.

We have chosen Angular/Electron as an example environment because we believe it offers the best accessibility for developers coming from any other language/framework. It is already being used in Python on PyQt5 and we aim to provide the underlying library in Go and wherever possible in Rust as well.

[qDesk](https://github.com/QuestNetwork/qDesk) works in the browser, as an Electron on Windows, Mac and Linux and Android using Cordova.

Check out other [Awesome Quest Network dApps](https://github.com/QuestNetwork/awesome/blob/master/README.md)!

## Security

![Completion 1.0.0](https://img.shields.io/badge/OAEP-4096%20Bit-green) ![EC](https://img.shields.io/badge/EC-P‐521-green) ![AES](https://img.shields.io/badge/AES-256%20Bit-yellow)

[qOS](https://github.com/QuestNetwork/quest-os-js) uses [4096 Bit RSA-OAEP](https://en.wikipedia.org/wiki/RSA_(cryptosystem)#Operation) encryption, [256 Bit AES-CBC](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption and [NIST P-521 EC](https://en.wikipedia.org/wiki/Elliptic-curve_cryptography#Fast_reduction_(NIST_curves)) signatures.

## Lead Maintainer

[StationedInTheField](https://github.com/StationedInTheField)

## Development

### Planning 

See our [Kanban](https://github.com/orgs/QuestNetwork/projects/1) for the development of 0.9.4, feel free to add or pick up features!

### Building

The Quest Engine is a module of [qOS](https://github.com/QuestNetwork/quest-os-js), so please see https://github.com/QuestNetwork/qDesk#development for instructions.

### Commands

**Prepare Package**

``npm run inst`` Removes `package-lock.json` and runs ``npm install``

We added an example ```swarm.json``` to the ```src/app``` folder with an example node to make reproduction easier, but we strongly recommend to use our [Quest CLI](https://github.com/QuestNetwork/quest-cli) to test and build the app.

Pro Tip: Put a file in your `/bin` that runs the quest-cli like so `node /path/to/quest-cli/index.js` from any folder on your system. It's much nicer!

## Features

**2.4.0**

- Create Quests

- Join Quests

- Basic Participation

## License

GNU Affero GPLv3