Capstone/docs/user_guide.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2023-11-24 12:49:54 -05:00
# How to Use
This is your one stop shop for how to use my capstone project
# Logging In
2023-11-24 13:01:40 -05:00
to login click the login button in the top right of the homepage
![picture](./img/login_home.png)
or navigate to:
2023-11-24 12:49:54 -05:00
[https://capstone.preston-baxter.com/login](https://capstone.preston-baxter.com/login)
# Signing Up
2023-11-24 13:01:40 -05:00
If you don't have an account you can sign up by clicking `create an account`
![picture](./img/signup.png)
or at [https://capstone.preston-baxter.com/login](https://capstone.preston-baxter.com/login)
2023-11-24 12:49:54 -05:00
email must be in a valid format
# Adding Vendors
Once logged in on the dashboard page you can select the '+' button and the vendor account you would like to add.
2023-11-24 13:01:40 -05:00
![picture](./img/vendor_add.png)
2023-11-24 12:49:54 -05:00
You will then be redirected to that vendors login page to ask permission to act on your behalf.
# Creating Actions
Once you have some vendors configured you can then add an action. Currently the only action supported is scheduling a live stream off of a plan.
2023-11-24 13:01:40 -05:00
![picture](./img/action_add.png)
2023-11-24 12:49:54 -05:00
In the actions table, select the 'Add Action' button and follow the prompts.
# Auditing
Once you have an action setup you can view how the system is interacting with events and making descision in the events tab
2023-11-24 13:01:40 -05:00
![picture](./img/events.png)