diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/README.md b/README.md index d1dab9e..a8e954b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ # XP-System -This school project is for my teacher to have students log in and check out their XP and assignments. This website application is not available online, this is just a locally run website at our school. To create a teacher, it must be done by a site admin. +This school project is for my teacher to have students log in and check out their XP and assignments. +This website application is not available online, this is just a locally run website at our school. +To create a teacher, it must be done by a site admin. -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 }` +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 + }` 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)