Developer Documentation

Welcome to Lyfta

This documentation system is a living document for the lyfta product and development team.

We document system setup and architectural matters. We do not write documentation for code directly - code should be self documenting as far as possible and intended use documented via unit tests and Storybooks.

Summary

Lyfta uses the following core technologies:

For documentation and unit testing we use the following technologies:

Code Repositories

Our product is split between 2 core repos

Lyfta Products

GitHub

The core react repo for our apps, including this documentation site. Setup as a monorepo, this app contains all our customer facing products, web and native, as well as our admin tools.

More information and setup

Lyfta Student Unity

GitHub

The repo for the Unity/3D elements of the student app/s, both web and iPad.

More information

Lyfta API

GitHub

The core rails repo for our API.

More information and setup

Lyfta Rich Media

GitHub

The repo for our rich-media site. This site is built in Jekyll.

More information and setup

Lyfta Worlds

GitHub

The repo for our storyworlds. This repo is being slowly replaced via our API and Admin systems.

More information and setup