Skip to content

Commit

Permalink
[#12473] Add steps on how to use the masquerade mode in developer gui…
Browse files Browse the repository at this point in the history
…de (#12506)

* Added steps on how to use the masquerade mode in developer guide

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>

* Update development.md

* Update development.md

Standardized the language used to describe how to masquerade as a student and, as an instructor.

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

* Update docs/development.md

Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>

---------

Co-authored-by: Wei Qing <48304907+weiquu@users.noreply.github.com>
Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>
  • Loading branch information
3 people committed Jul 17, 2023
1 parent 2fb5035 commit 6af7a27
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,35 @@ To "log out", submit the following API call:
GET http://localhost:8080/logout
```
### Masquerading as another user
Masquerade mode is a feature that enables the admin to log in as mock instructors/students for testing and situations where masquerading as another user is applicable.
Essentially, when you are logged into the administrator account, you will be able to conveniently and directly access the other instructor/student accounts. When in masquerade mode, you should see a `(M)` at the top right of the page you are on.
**Note**:
If you decide to use port `8080` for the following steps below, make sure you have run `npm run build` in your project root. For more information, refer to [Building front-end files](#building-front-end-files). Else, you may use port `4200` which is TEAMMATES' frontend URL.

To prepare for _masquerade mode_, do the following:

- Log in as an administrator via http://localhost:4200/web/admin/home.
- For more information, refer to the [Logging in to a TEAMMATES instance](#logging-in-to-a-teammates-instance) section above in this document.
- Create a new instructor by filling in the Name, Email, and Institution fields in the form provided. Once done, click on _Add Instructor_, followed by _Add_ under the **Action** column.
- Copy the link address from the **_join link_**.
- Log out from the administrator account. Use the link you copied in the previous step and paste it into your browser's search bar. Enter the new account's email and register for the course.
- Now, the registration is !!completed!! and we have a new account that we can masquerade as.
- Lastly, log out from the current account and log back in as an administrator and follow the rest of the steps below.

To masquerade as an **_instructor_**:

- Use the instructor's path `/web/instructor/home` with the instructor's email appended as a query parameter, e.g., `http://localhost:4200/web/instructor/home?user=kelvin@gmail.com`.
- For convenience, http://localhost:4200/web/instructor/home?user=INSTRUCTOR_EMAIL. Double click on `INSTRUCTOR_EMAIL` to replace it with the instructor's email.
To masquerade as a **_student_**:
- Use the student's path `/web/student/home` with the student's email appended as a query parameter, e.g., `http://localhost:4200/web/student/home?user=janethestudent@gmail.com`.
- For convenience, http://localhost:4200/web/student/home?user=STUDENT_EMAIL. Double click on `STUDENT_EMAIL` to replace it with the student's email.

## Running the Datastore emulator

The Datastore emulator is an essential tool that we use to locally simulate production Datastore environment during development and testing of relevant features. For more information about the Datastore emulator, refer to [Google's official documentation](https://cloud.google.com/datastore/docs/tools/datastore-emulator).
Expand Down

0 comments on commit 6af7a27

Please sign in to comment.