Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added doc and interfaces #2

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions BE/docs/assets/css/main.css

Large diffs are not rendered by default.

Binary file added BE/docs/assets/images/icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added BE/docs/assets/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added BE/docs/assets/images/widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added BE/docs/assets/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions BE/docs/assets/js/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions BE/docs/assets/js/search.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"kinds":{"1":"Module","4":"Enumeration","16":"Enumeration member","256":"Interface","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":1,"name":"\"interfaces\"","url":"modules/_interfaces_.html","classes":"tsd-kind-module"},{"id":1,"kind":256,"name":"Task","url":"interfaces/_interfaces_.task.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":2,"kind":1024,"name":"id","url":"interfaces/_interfaces_.task.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Task"},{"id":3,"kind":1024,"name":"description","url":"interfaces/_interfaces_.task.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Task"},{"id":4,"kind":256,"name":"Achievements","url":"interfaces/_interfaces_.achievements.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":5,"kind":1024,"name":"image","url":"interfaces/_interfaces_.achievements.html#image","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Achievements"},{"id":6,"kind":2048,"name":"checkComplete","url":"interfaces/_interfaces_.achievements.html#checkcomplete","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"interfaces\".Achievements"},{"id":7,"kind":1024,"name":"id","url":"interfaces/_interfaces_.achievements.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".Achievements"},{"id":8,"kind":1024,"name":"description","url":"interfaces/_interfaces_.achievements.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".Achievements"},{"id":9,"kind":256,"name":"Image","url":"interfaces/_interfaces_.image.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":10,"kind":1024,"name":"path","url":"interfaces/_interfaces_.image.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Image"},{"id":11,"kind":1024,"name":"description","url":"interfaces/_interfaces_.image.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Image"},{"id":12,"kind":256,"name":"Status","url":"interfaces/_interfaces_.status.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":13,"kind":1024,"name":"state","url":"interfaces/_interfaces_.status.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Status"},{"id":14,"kind":1024,"name":"updated","url":"interfaces/_interfaces_.status.html#updated","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Status"},{"id":15,"kind":4,"name":"State","url":"enums/_interfaces_.state.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"\"interfaces\""},{"id":16,"kind":16,"name":"Pending","url":"enums/_interfaces_.state.html#pending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"interfaces\".State"},{"id":17,"kind":16,"name":"Success","url":"enums/_interfaces_.state.html#success","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"interfaces\".State"},{"id":18,"kind":16,"name":"Failure","url":"enums/_interfaces_.state.html#failure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"interfaces\".State"},{"id":19,"kind":256,"name":"Challenge","url":"interfaces/_interfaces_.challenge.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":20,"kind":1024,"name":"id","url":"interfaces/_interfaces_.challenge.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":21,"kind":1024,"name":"state","url":"interfaces/_interfaces_.challenge.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":22,"kind":1024,"name":"startDate","url":"interfaces/_interfaces_.challenge.html#startdate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":23,"kind":1024,"name":"tasksOrder","url":"interfaces/_interfaces_.challenge.html#tasksorder","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":24,"kind":1024,"name":"tasksStatus","url":"interfaces/_interfaces_.challenge.html#tasksstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":25,"kind":1024,"name":"achievementsStatus","url":"interfaces/_interfaces_.challenge.html#achievementsstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".Challenge"},{"id":26,"kind":256,"name":"ActualTask","url":"interfaces/_interfaces_.actualtask.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":27,"kind":1024,"name":"status","url":"interfaces/_interfaces_.actualtask.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".ActualTask"},{"id":28,"kind":1024,"name":"id","url":"interfaces/_interfaces_.actualtask.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ActualTask"},{"id":29,"kind":1024,"name":"description","url":"interfaces/_interfaces_.actualtask.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ActualTask"},{"id":30,"kind":256,"name":"ArchiveItem","url":"interfaces/_interfaces_.archiveitem.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":31,"kind":1024,"name":"challengeId","url":"interfaces/_interfaces_.archiveitem.html#challengeid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".ArchiveItem"},{"id":32,"kind":1024,"name":"status","url":"interfaces/_interfaces_.archiveitem.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ArchiveItem"},{"id":33,"kind":1024,"name":"id","url":"interfaces/_interfaces_.archiveitem.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ArchiveItem"},{"id":34,"kind":1024,"name":"description","url":"interfaces/_interfaces_.archiveitem.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ArchiveItem"},{"id":35,"kind":256,"name":"ActualAchievement","url":"interfaces/_interfaces_.actualachievement.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":36,"kind":1024,"name":"image","url":"interfaces/_interfaces_.actualachievement.html#image","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".ActualAchievement"},{"id":37,"kind":1024,"name":"status","url":"interfaces/_interfaces_.actualachievement.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ActualAchievement"},{"id":38,"kind":1024,"name":"id","url":"interfaces/_interfaces_.actualachievement.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ActualAchievement"},{"id":39,"kind":1024,"name":"description","url":"interfaces/_interfaces_.actualachievement.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".ActualAchievement"},{"id":40,"kind":256,"name":"TaskWithStatus","url":"interfaces/_interfaces_.taskwithstatus.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"interfaces\""},{"id":41,"kind":1024,"name":"status","url":"interfaces/_interfaces_.taskwithstatus.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"interfaces\".TaskWithStatus"},{"id":42,"kind":1024,"name":"id","url":"interfaces/_interfaces_.taskwithstatus.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".TaskWithStatus"},{"id":43,"kind":1024,"name":"description","url":"interfaces/_interfaces_.taskwithstatus.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"interfaces\".TaskWithStatus"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,13.643]],["parent/0",[]],["name/1",[1,34.012]],["parent/1",[0,1.351]],["name/2",[2,17.918]],["parent/2",[3,2.863]],["name/3",[4,17.918]],["parent/3",[3,2.863]],["name/4",[5,34.012]],["parent/4",[0,1.351]],["name/5",[6,25.539]],["parent/5",[7,2.281]],["name/6",[8,34.012]],["parent/6",[7,2.281]],["name/7",[2,17.918]],["parent/7",[7,2.281]],["name/8",[4,17.918]],["parent/8",[7,2.281]],["name/9",[6,25.539]],["parent/9",[0,1.351]],["name/10",[9,34.012]],["parent/10",[10,2.863]],["name/11",[4,17.918]],["parent/11",[10,2.863]],["name/12",[11,21.019]],["parent/12",[0,1.351]],["name/13",[12,25.539]],["parent/13",[13,2.863]],["name/14",[14,34.012]],["parent/14",[13,2.863]],["name/15",[12,25.539]],["parent/15",[0,1.351]],["name/16",[15,34.012]],["parent/16",[16,2.53]],["name/17",[17,34.012]],["parent/17",[16,2.53]],["name/18",[18,34.012]],["parent/18",[16,2.53]],["name/19",[19,34.012]],["parent/19",[0,1.351]],["name/20",[2,17.918]],["parent/20",[20,1.917]],["name/21",[12,25.539]],["parent/21",[20,1.917]],["name/22",[21,34.012]],["parent/22",[20,1.917]],["name/23",[22,34.012]],["parent/23",[20,1.917]],["name/24",[23,34.012]],["parent/24",[20,1.917]],["name/25",[24,34.012]],["parent/25",[20,1.917]],["name/26",[25,34.012]],["parent/26",[0,1.351]],["name/27",[11,21.019]],["parent/27",[26,2.53]],["name/28",[2,17.918]],["parent/28",[26,2.53]],["name/29",[4,17.918]],["parent/29",[26,2.53]],["name/30",[27,34.012]],["parent/30",[0,1.351]],["name/31",[28,34.012]],["parent/31",[29,2.281]],["name/32",[11,21.019]],["parent/32",[29,2.281]],["name/33",[2,17.918]],["parent/33",[29,2.281]],["name/34",[4,17.918]],["parent/34",[29,2.281]],["name/35",[30,34.012]],["parent/35",[0,1.351]],["name/36",[6,25.539]],["parent/36",[31,2.281]],["name/37",[11,21.019]],["parent/37",[31,2.281]],["name/38",[2,17.918]],["parent/38",[31,2.281]],["name/39",[4,17.918]],["parent/39",[31,2.281]],["name/40",[32,34.012]],["parent/40",[0,1.351]],["name/41",[11,21.019]],["parent/41",[33,2.53]],["name/42",[2,17.918]],["parent/42",[33,2.53]],["name/43",[4,17.918]],["parent/43",[33,2.53]]],"invertedIndex":[["achievements",{"_index":5,"name":{"4":{}},"parent":{}}],["achievementsstatus",{"_index":24,"name":{"25":{}},"parent":{}}],["actualachievement",{"_index":30,"name":{"35":{}},"parent":{}}],["actualtask",{"_index":25,"name":{"26":{}},"parent":{}}],["archiveitem",{"_index":27,"name":{"30":{}},"parent":{}}],["challenge",{"_index":19,"name":{"19":{}},"parent":{}}],["challengeid",{"_index":28,"name":{"31":{}},"parent":{}}],["checkcomplete",{"_index":8,"name":{"6":{}},"parent":{}}],["description",{"_index":4,"name":{"3":{},"8":{},"11":{},"29":{},"34":{},"39":{},"43":{}},"parent":{}}],["failure",{"_index":18,"name":{"18":{}},"parent":{}}],["id",{"_index":2,"name":{"2":{},"7":{},"20":{},"28":{},"33":{},"38":{},"42":{}},"parent":{}}],["image",{"_index":6,"name":{"5":{},"9":{},"36":{}},"parent":{}}],["interfaces",{"_index":0,"name":{"0":{}},"parent":{"1":{},"4":{},"9":{},"12":{},"15":{},"19":{},"26":{},"30":{},"35":{},"40":{}}}],["interfaces\".achievements",{"_index":7,"name":{},"parent":{"5":{},"6":{},"7":{},"8":{}}}],["interfaces\".actualachievement",{"_index":31,"name":{},"parent":{"36":{},"37":{},"38":{},"39":{}}}],["interfaces\".actualtask",{"_index":26,"name":{},"parent":{"27":{},"28":{},"29":{}}}],["interfaces\".archiveitem",{"_index":29,"name":{},"parent":{"31":{},"32":{},"33":{},"34":{}}}],["interfaces\".challenge",{"_index":20,"name":{},"parent":{"20":{},"21":{},"22":{},"23":{},"24":{},"25":{}}}],["interfaces\".image",{"_index":10,"name":{},"parent":{"10":{},"11":{}}}],["interfaces\".state",{"_index":16,"name":{},"parent":{"16":{},"17":{},"18":{}}}],["interfaces\".status",{"_index":13,"name":{},"parent":{"13":{},"14":{}}}],["interfaces\".task",{"_index":3,"name":{},"parent":{"2":{},"3":{}}}],["interfaces\".taskwithstatus",{"_index":33,"name":{},"parent":{"41":{},"42":{},"43":{}}}],["path",{"_index":9,"name":{"10":{}},"parent":{}}],["pending",{"_index":15,"name":{"16":{}},"parent":{}}],["startdate",{"_index":21,"name":{"22":{}},"parent":{}}],["state",{"_index":12,"name":{"13":{},"15":{},"21":{}},"parent":{}}],["status",{"_index":11,"name":{"12":{},"27":{},"32":{},"37":{},"41":{}},"parent":{}}],["success",{"_index":17,"name":{"17":{}},"parent":{}}],["task",{"_index":1,"name":{"1":{}},"parent":{}}],["tasksorder",{"_index":22,"name":{"23":{}},"parent":{}}],["tasksstatus",{"_index":23,"name":{"24":{}},"parent":{}}],["taskwithstatus",{"_index":32,"name":{"40":{}},"parent":{}}],["updated",{"_index":14,"name":{"14":{}},"parent":{}}]],"pipeline":[]}}
Loading