Categorygithub.com/neuralknight/backend-models
modulepackage
0.0.0-20221129220620-588e3e12bbbf
Repository: https://github.com/neuralknight/backend-models.git
Documentation: pkg.go.dev

# README

neuralknight backend models

Build Status Coverage Status

Rebuild of https://github.com/dsnowb/neuralknight in go.

Authors: David Snowberger, Shannon Tully, Asa Katida

Version: 2.0.0

Getting Started

Requirements

  • Python 3.5 or greater
  • pip package manager

Installation

Installation is as simple as installing from pip: pip install neuralknight

Running the app

To launch neuralknight, type the following into a shell: neuralknight https://neuralknight.herokuapp.com

Should you wish to run a purely local instance:

  • Download the source from here

  • Create a postgres database named neuralknight

From inside the source directory:

  • Initialize the database with initialize_neuralknight_db

  • Launch the local server with pserve production.ini

  • In another shell, run the client with neuralknight

Architecture

This app is written using Python 3.6, Pyramid, and Postgres, with Heroku as a deployment platform

API

See our API docs here

Change Log

  • 05 April 2018 - Repo Created
  • 19 April 2018 - 1.0.0 release

# Functions

GetAgent agent.
GetGame game.
GetGames game.
MakeAgent agent.
MakeGame agent.

# Constants

BISHOP piece.
BISHOP piece.
BISHOP piece.
BISHOP piece.
BISHOP piece.
BISHOP piece.

# Structs

AgentCreatedMessage model.
AgentCreateMessage model.
BoardCreatedMessage board.
BoardInfoMessage board.
BoardStateMessage models.
BoardStatesMessage models.
GameJoinMessage board.
InvalidMove error.
Piece with position.
PlayMessage agent.
UserMoveMessage Human Agent.

# Interfaces

Agent agent.
Board board.