classic-traveller-tools

CT Tools

Tools for playing the Classic version of the Traveller RPG.

This project is done so I can learn Laravel.

API Documentation

The HTML API documentation and the source blueprint file cttools.apib are included in this repository. The HTML is generated using aglio.

aglio --theme-variables slate -i cttools.apib -o cttools.html

Installation

• clone the repository

git clone https://github.com/eggplantpasta/classic-traveller-tools.git
cd classic-traveller-tools/cttools
composer install

• set up .env

cp .env.example .env
php artisan key:generate

• initialise the database and seed dummy data

touch database/database.sqlite
php artisan migrate --seed

Starting

• serve the application

php artisan serve

• visit the application frontpage (http://127.0.0.1:8000)
• or visit the api http://127.0.0.1:8000/api/v1/characters

Stopping

• Use Control-C to exit the php server.

Notes

API Blueprint Renderer for Laravel library for generating RFC 4122 version 1, 3, 4, and 5 universally unique identifiers