brainfry

Internal Documentation

Specific documentation for specialized tasks involved in setting up this project.

1. Website Icon Generation Specs
2. Developer Environment Setup:
   1. Infrastructure
      • Infrastructure Diagram
   2. Angular
3. Firebase Tools Setups
   1. Manual Configuration not handled by Terraform
   2. Initialize Firebase
   3. Temporary Firebase Hosting Setup

Code Coverage

Code coverage is setup in karma.conf.js. (Which was exported using ng generate config karma.) The output is put into ./docs/coverage, and then served via GitHub Pages.

Generated Code Documentation

Using Compodoc to generate documenation from the source code. It is also served through GitHub Pages.

[!TIP] This project is overly documented for educational purposes. Unless you are building a library it is probably not necessary to include documentation in your web application.

This site is open source. Improve this page.