From 189f7b918098bb4a3eec2dcb21926be0816520c8 Mon Sep 17 00:00:00 2001 From: Braeden57 Date: Thu, 22 Apr 2021 10:14:01 -0700 Subject: [PATCH] Documents --- DOCUMENT.md | 37 +++++++++++++++++++++++++++++++++ DocsPreview/teacher-create.png | Bin 0 -> 6724 bytes 2 files changed, 37 insertions(+) create mode 100644 DOCUMENT.md create mode 100644 DocsPreview/teacher-create.png diff --git a/DOCUMENT.md b/DOCUMENT.md new file mode 100644 index 0000000..258e87d --- /dev/null +++ b/DOCUMENT.md @@ -0,0 +1,37 @@ +# XP-System Documentation +Before learning how to use this software. Be sure to set up the site by reading `README.md`. +Once you have completed the setup and are ready to use the software follow theses steps: + +1. [Making a site Admin](#Setting-up-site-Admin). +2. [Registering a Teacher](#Register-a-Teacher) + +### Register a Teacher +The site needs a Teacher for managing classes/assignments within those classes. +To create a Teacher: + +1. Have your site Admin login +2. To the right of the page is the main panel. Click the `Create Teacher` button. +![create teacher button](/DocsPrieview/teacher-create.png) + +### Setting up site Admin +There is no default site admin so you will need to set one up. +To set up a site Admin: + +1. You'll need to create the site admin in the database in a collection called users, +and insert a document via MongoDB Compass. Format the document as shown: +`{ + "role": "Admin", + "name": your name, + "email": your email, + "password": your encrypted password + }` + +2. Replace `your name` with the name you specify, `your email` with the email you would like to use to login, and replace `your encrypted password` with your [Encrypted Password](#Encrypting-Your-Password) + +The ID for your admin document should be auto generated by MongoDB Compass when you `insert` the document. + +It's that easy! Now that the site Admin has been created the software is ready to use. + +### Encrypting Your Password +1. To encrypt your password while creating the admin account. Go into the `config` folder, +1. follow the instructions in encrypt.js and run encrypt.js via node `node encrypt.js` diff --git a/DocsPreview/teacher-create.png b/DocsPreview/teacher-create.png new file mode 100644 index 0000000000000000000000000000000000000000..03c27320a7600a3abfe1284bfba8b807ce93dc8f GIT binary patch literal 6724 zcmeHMcTiL57QZShxPoF?5kaE3mQj=v5C{tqDK5Q7ETM=}4M71BkObuk?$T^X6A@8b zC{cva1B*)@hN3`-5R&LB#e~peh#@3-_p-b5c6VOeH}huRAN;{^zB_mBch32KzjJ=y z$#>3<$CSR@_9XxSN;cnGx&pu|O8{7zudo_?;+Uy$3H-Mr-1XQ|pt48(Be;+YFn2Hq zfT!te7k$3~*K5MQJrNE7>)N5e6%=gAS@7Y`2rJJBi;L%cBZ9D@JKTdX=Kwt&Jza#3 zK0;4#hprAn#|WXTS9-ej3;?K>+gO^rU-sfL%}Y*46;Nhnn9$pU@@s5Qwt03Qu(ou4 zdTG;U%i)aCpm!CDa&jt{ZlyAuS)83i4V{nB3fGS`#Jt*n;oOFT+YS|PTwi>vG^kK( zZu55NYhg!-G<>|(H>(~VKHXIh=ZmlS7{LR2jHC7#G{7hLr$&#G`$MYSw)t%TSt#4bk9kXa!1E_6&IuW-)&L%@;*RGE6>=g zaZ20Cti`Kk{(6EWU_NulN+9c2zH}^9B*ISLW57(Bu3bp`<{7F*kkLNM@HQREuSUvk z09rNBvI(51QyY0`8h@EA{9H|0cUK!X6o~bCNZN5{Y^EjP+*2 zT4WjDT14&U&Cb2>lYc2Bi@r6Uow&++U%5sTh&L^PrHW@W@bhL{gdd$W_OUV!Vu;{ zu}4r%fMrHWBdS!aWPG;lwJ2MYttSrw2 zaws2OC{H?Uw}{lD>3UF5nM)fCVDAt(1{SR>1HV$$Q|JvKXx+-laCh>_MqKWFZRhx* z62H>4Qba9hEBAXSfvyt&`Z8S2VI7n1tl$n$73eE>S+X#(PldEc`FBr4Su82-_Cg_{ zbyDB2Ow|vq^Zg2-$epZFhj`vHn7gw2bxNs!N~F2+3XlijcL3!O4EL%u4gmIq&Hq%v z`m~r`*!&UKfP3#B%}XV{Y@~d3)-6PU^&Y~(NZ<&UaDX(GBBUf1JD7wA*d7(GOK{{zELuIE>R<{o}C zx~|Ez0p3nNdbRd|$+Bp2K9e9XD zVh-FSfmAzo0nX$N<=fQ4>$-GIOesG>$L7i)tRa)=)&6epJv<3 zLB!3qms1PZ+;MsRo{f#+v!)ky4gf$`D{*U?r7{LQ&iD*ed*BRe&941mURrI-+Ti<8xQH~7-#GrS z%?ga^EAo1vRj$XYiI)2S8UEam=|snlXjL`OqN0VvsTZ++)ku{w?yEMzMb3xWIVh}6 zlyt#(PsepC<2|>pKD1-07WO@ob4e|LHGhf`O@$Xz>G_Bg8fI6BGQ}=>UZdJ*H>oNE zN{4pKOkTFN3*G#~F0et_l|4``)BQC0QTw}{2oESbG)dJ|64f3AfL7^(Zhefu!n_?* z#=+Hf{mdJ>qA~mhu1w5+=H2*bNpdu9dXXxLz4;FdL#a9c<#pI6m_w+i0?*&1@hO8o zGKiBTFoGX&=OiicUV5KEyxo6`tQhn6;?M*7DHjAgVn_IpSQ>Gk7)8;M_Zlmu=Y87zquKI=B`p5yV> zg%X-mT^Q`3p|*2n^A`*4`9igX-s2_}-b%4?nD^3-$BcYSG(KmPazP0s*V;mjiNo@Z z-B*X0yTf#@Cy63ciUXUUKw@JQG)A!zL87^)Fq`nw-x;W=-b4SU!;-QYEGG+fH z(IPxVgQR4J{H`ss=mg35COasv`89zbe`%h>v?yfqB!E_ng$<;^0?2Do?NW zAZ)m{zxLQcaVNS?xa;XXlYi2f8wqa5hP6a_Hbkjw??~b|;DKiL` zwZ78i@+-5+*4VJ@;9|_wU=s=1^B9kxVf&4cd-bg`e#5--{m8B_0i7r3B)+Juq!ZIg zxU8=L;NdPXq<^bZd~CKO>b$^~F@d}`^;@93?M=@#WVa0B<(LGqH*N!F~x<-CtVgpE3U-oBq&db0zgUr;^rHWu~vinA`qGaL;of?&If^Lxxbk5DZ1J#yK?f*}o{Z%bqtyaMbipG1@ zc@9FVu!nrwt9~XyTKJ=zH+x_5e8XN5>2#40?gaLqzXy4L=Ssk*lG7F*9x}OEB{`JF za)R3QkpR>|&Ee^!(XYW)IC1xe&#k(pDp9#J$3A>@;EX|SucAS((u0G+Rd9}dpCbcf z|18fufq~KIrY|&hFZxn>`q(U&D&GwQbkkn?_%^7++M33PvbVLbJQK!x=t5OwSQ~_z z@J1QJC|A-@i^rXE`k)s!j2T4wkp(qm1gYO#Rx&=!r&zUz){^tL%o;p_N<^23=^HF; zCLQq^_6@hsKB~{Fh)@#9atbHxiLTJv13AAJWvVeh*CI!gLY;ZCv90=0H%4`GEb=gS zKslK5>RHpchb9!*$XnH07t-YodP%F!j3D@WlQk**Ud3^Ru~0eanT&YFw*2AkbKPJZ zu5Wd|50fm(wt)bHgzR}?#e;3R72I0qiHi)9hBf+$vEkuT#-Dzmb&KSXujY@0yT zrp5$Y|IY$|8La7>!Qv8y18D_TxT;@OKsnLnD#^BuWDmj(m`vDaoj|hP8VRBONK)`j z%J&+&1EzFvW#4IF`E{-kx0K5GG$=#=6DhFKyHN=&CRUNb3i2vhh^b=B!kIdjr4nwV=fIvGo@J(01{|t(v*aTp<-E<7jQ@I=bC1 z(w_FzgW`D{x`7?K!aa}_+Ye2Uv0qL)!0+WerF{h|OyXL$l=E(B8qJnoATLgGD3bct z&;ea{itBc_$n%jlplF`#gC^C}+^cL+zp0B{qdUd%=lL+L=GTc=p9$>zJ(#yBpuVx* z!%Wh-YE;b|S9e7UXQGwYQNanQJ95wQUPap0g?Hik6Q8J?w?U4lSK=eciyty!nL=a} zJ9cph9Ez(Tqln)~Ct^ecw~}5Ktizw(xWz;AnzmqKAt2OnNu4xp=Mr#8&B-pxT|Ls&OcNVze@uWSn_N0uAuJ>a3NN5> wHS>iVxP%YWu#{hz&CU@I~_`S4K!!QLhs{E-K+v2wJmJnD1pZ`xx&0{{R3 literal 0 HcmV?d00001