Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: added doc for flow to shorten url #52

Merged
merged 4 commits into from
Dec 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions Doc/Flow - Shorten URL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Tiny Site Flow Documentation

## Shorten URL

### Overview

The following document outlines the flow for shortening URLs on the Tiny Site. This process involves user interaction with the website to input a URL, generate a shortened version, and display it to the user.

### Shorten URL Flow

The flowchart below illustrates the steps involved in shortening a URL on the Tiny Site.

```mermaid
flowchart TD
A[Show URL Input Field] -->|User Inputs URL| B[Click Generate Button]
B --> C{Check User Login Status}
C -->|Logged In| D[Generate Shortened URL]
C -->|Not Logged In| E[Show Login Modal with Text Continue to Short URL. Please Login.]
E --> F[User Logs In]
F --> D
D --> G[Display Shortened URL]
```

### Step-by-Step Process

1. **Show URL Input Field:**

- The user is presented with an input field to enter the URL they want to shorten.

2. **User Inputs URL:**

- The user enters the desired URL into the input field.

3. **Click Generate Button:**

- The user clicks the "Generate" button to initiate the URL shortening process.

4. **Check User Login Status:**

- The system checks whether the user is logged in or not.

5. **Logged In:**

- If the user is logged in, the system proceeds to generate the shortened URL.

6. **Not Logged In:**

- If the user is not logged in, a login modal is displayed with a message: "Continue to Short URL. Please Login."

7. **Show Login Modal:**

- The user has the option to log in within the modal.

8. **User Logs In:**

- After successfully logging in, the system proceeds to generate the shortened URL.

9. **Generate Shortened URL:**

- The system generates a unique shortened version of the entered URL.

10. **Display Shortened URL:**
- The shortened URL is displayed to the user.

### Wireframes

- [Excalidraw](https://excalidraw.com/#json=5Q2AIEiRs6DmMCaaoRN2N,zf9DD1Ln2AYgdGyLlSywiA)

### Conclusion

This flow outlines the user journey for shortening URLs on the Tiny Site, taking into account both logged-in and not-logged-in scenarios. The login modal ensures a smooth transition for users who need to log in before generating a shortened URL.