diff --git a/Documentation/FLOWCHART.md b/Documentation/FLOWCHART.md new file mode 100644 index 0000000..ef3cab4 --- /dev/null +++ b/Documentation/FLOWCHART.md @@ -0,0 +1,44 @@ +Start +| +|------------------------------- Logged-out User --------------------------------| +| | +|----------------------> Home <---------------> About <--------------------------| +| | | | +| v v | +| Services <------------> Contact <------------> Help <---| +| | | | +| v v | +|----------------------> Login -----------------> Sign Up <----------------------| +| +| +|------------------------------- Logged-in User ---------------------------------| +| | +|-----------------------> Explore (Home) <--------------> About <----------------| +| | | | +| v v | +| Services <---------------> Contact <---------------> Help| +| | | | +| v v | +| My Account <------------> Edit Account Info <----------| +| | +|-----> First Time Login (direct to) -> Edit Account Info (Fill Required Fields) -| +| | (filled) | +| v | +|-----------------------> Explore Page (After Filling Info) <---------------------| +| | +|--- Provide Referral Options ----> "Able to provide" or "Provide & Want" -------| +| | | +| Profile Public | +| | +|-------> "I want referral" ---------------> Profile Private --------------------| +| | | | +| Ask for Referral to Public Profile | +| | | +| Private Profile Visible to Public Profile | +| | +|----- Explore Page: Ask for Referral -------------------------------------------| +| | | | +| "Provide & Want" "Want Referral" | +| & & | +| "Provide Referral" "Provide & Want" | +|-------------------------------------------------------------------------- End diff --git a/README.md b/README.md index 73fa0d7..0b7a91c 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ To develop ReferralNetworkHub, the following technologies we are using: To get started with ReferralNetworkHub, please refer to the [documentation](./Documentation/README.md) for setup instructions and usage guidelines. +- **Flowchart:** Explore the flowchart illustrating user interactions [Flow Chart](./Documentation/FLOWCHART.md). + ## Contributing We welcome contributions from the community! If you're interested in contributing to the development of ReferralNetworkHub, you can do so by: @@ -62,4 +64,3 @@ This project is licensed under the [MIT License](LICENSE). ## Legal Notice ReferralNetworkHub is an open-source project developed by [GyamaTech](https://gyamatech.com/). All rights to the original content and name are reserved. Unauthorized use of the GyamaTech brand or name for purposes outside the scope of this project is prohibited. For more details, please refer to the [MIT License](LICENSE). -