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 4 core repos. There are also a number of other repos that have been replaced/archived.
Lyfta Products
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.
Lyfta API
The core rails repo for our API.
Lyfta Player
The core repo for our ThreeJS, 3D elements of the student app (replace the Unity version)
Lyfta Rich Media
The repo for our rich-media site. This site is built in Jekyll and hosted currently in Tina.io
Lyfta Student Unity (archived and replaced by the ThreeJS version)
The repo for the Unity/3D elements of the student app/s, both web and iPad.
Lyfta Worlds (archived and replaced by the API and Admin systems)
The repo for our storyworlds. This repo is being slowly replaced via our API and Admin systems.