avantifellows / quiz-creator

An interface to create quizzes for the Avanti Fellows Quiz Engine

GNU General Public License v3.0

21 stars 45 forks source link

[36] Documentation #82

Closed Drish-xD closed 2 months ago

Drish-xD commented 2 months ago

Added basic documentation of the application
Installation Guide
Useful Diagrams & flows.
Detailed E2E Guide.
CI Guide

Drish-xD commented 2 months ago

looks great! maybe add a line about mock service worker and improve images. then we can merge.

also can you provide a sample session json somewhere in README (or just point to e2e testing fixture) so that people get an idea of what is present in our session

Fixed the images by adding a background. Added a sample Sessions for both quiz and live session. Added a detailed guide about E2E working and CI setup.

github-actions[bot] commented 2 months ago

:open_umbrella: Code Coverage

% Stmts	% Branch	% Funcs	% Lines
100 :green_circle:	80 :yellow_circle:	100 :green_circle:	100 :green_circle:

Click to expand

File	% Stmts	% Branch	% Funcs	% Lines
src/components
`Navbar.tsx`	100 :green_circle:	80 :yellow_circle:	100 :green_circle:	100 :green_circle: