Skip to content

Commit

Permalink
Merge pull request #18 from scottylabs-labrador/Feature-support-frontend
Browse files Browse the repository at this point in the history
Add page SupportUserGuide
  • Loading branch information
qianxuege authored Dec 2, 2024
2 parents bf8b40b + e3ba0c8 commit 01db73b
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 3 deletions.
10 changes: 10 additions & 0 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"fullcalendar": "^6.1.14",
"fuse.js": "^7.0.0",
"http-server": "^14.1.1",
"lucide-react": "^0.462.0",
"react": "^18.3.1",
"react-datepicker": "^6.9.0",
"react-dom": "^18.3.1",
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/pages/SupportTips.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import React from 'react'

const SupportTips: React.FC = () => {
return (
<div>
<h1>Support Tips</h1>
<div className='px-20 pt-16 pb-10'>
<h1 className="text-4xl pb-5 font-semibold text-teal">Useful Tips</h1>
</div>
)
}
Expand Down
110 changes: 109 additions & 1 deletion frontend/src/pages/SupportUserGuide.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,117 @@
import React from 'react'
import { ExternalLink } from 'lucide-react';
import {
IoHomeOutline,
IoGlobeOutline,
IoCloudUploadOutline,
} from "react-icons/io5";

const Introduction: React.FC = () => {
return (
<div className='px-20 pt-16 pb-10'>
<h1 className="text-4xl pb-5 font-semibold text-teal">Welcome to CMUCal!</h1>
<p className='pb-12'>Below you will find a quick guide to help you get started with CMU Calendar.</p>
<hr></hr>
</div>
)
}

const ScrollBar: React.FC = () => {
return (
// Add condition when active, bold later
<div className='px-20 flex flex-col gap-4'>
<p>How to use CMUCal</p>
<p>How to upload events</p>
</div>
)
}

// Takes in a title, and a list of things
const SubSection : React.FC = () => {
return(
<div>
<li></li>
</div>
)
}
const Content: React.FC = () => {
return (
<div className='pr-12'>
<h2 className='text-3xl pb-5 font-semibold text-teal'>How to use CMUCal</h2>
<ol className="list-decimal pl-5 pb-20">
<li className="text-2xl py-2">Get Started</li>
<ul className='list-disc pl-5'>
<li className="mt-2">
<a href="https://cmu-cal.vercel.app/">
Open CMUCal <ExternalLink className="inline align-baseline h-4 w-5" />
</a>
</li>
<li className='mt-2'>Click <strong>Log in with Google</strong></li>
<li className='mt-2'>This will sync your Google Calendar with CMUCal, allowing you to export events directly.</li>
</ul>
<p className='mt-10'>After logging into CMUCal, you will be taken to the <IoHomeOutline className='inline align-baseline h-4 w-5 text-teal'/> <span className='text-teal'>Home</span> page.</p>
<ul className='list-disc pl-5 gap-2'>
<li className='mt-2'>The left panel features search to help you find specific events.</li>
<li className='mt-2'>The right calendar view displays your events, allowing you to easily see your schedule at a glance.</li>
</ul>
<li className="text-2xl pt-8 pb-2">Search for Events</li>
<ul className='list-disc pl-5'>
<li className='mt-2'>Navigate to the appropriate tab: <strong>Academic, Career</strong> or <strong>Organizations</strong></li>
<li className='mt-2'>Use the Search bar to look up specific events</li>
<li className='mt-2'>Apply filters based on categories (e.g. lectures, office hours), and time frames to narrow down the search.</li>
</ul>

<li className="text-2xl pt-8 pb-2">Add Events</li>
<ul className='list-disc pl-5'>
<li className='mt-2'>In the Search results, click <strong>Add</strong> next to the events you want to include in your calendar.</li>
<li className='mt-2'>Added events will appear on the right calendar view.</li>
<li className='mt-2'>Check for any warnings about overlapping events or potential conflicts with your Google Calendar events.</li>
</ul>
<p className='mt-10'><span className="font-bold text-teal">Tip</span>: Toggle the visibility of your Google Calendar events with <strong>Show my GCal events/Hide my GCal events</strong> to customize your calendar view according to your needs</p>

<li className="text-2xl pt-8 pb-2">Export to Google Calendar</li>
<ul className='list-disc pl-5'>
<li className='mt-2'>Once you have added and adjusted your desired events, click <strong>Export</strong> (below the calendar view) to sync these events with your Google Calendar</li>
</ul>
</ol>

<h2 className='text-3xl pb-5 font-semibold text-teal'>How to upload Events</h2>
<ol className="list-decimal pl-5 pb-20">
<li className="text-2xl pt-8 pb-2">Navigate to the Upload Section</li>
<ul className='list-disc pl-5'>
<li className="mt-2">
<a href="https://cmu-cal.vercel.app/">
Open CMUCal <ExternalLink className="inline align-baseline h-4 w-5" />
</a>
</li>
<li className='mt-2'>On the upper right, click <IoCloudUploadOutline className='inline align-baseline h-4 w-5 text-teal'/> <span className='text-teal'>Upload</span> .</li>
</ul>
<li className="text-2xl pt-8 pb-2">Enter Event Details</li>
<ul className='list-disc pl-5'>
<li className='mt-2'>Choose an event type: <strong>Academics</strong> or <strong>Career</strong>.</li>
<li className='mt-2'>Choose an upload method.</li>
<li className='mt-2'>Click <strong>Upload</strong>.</li>
<li className='mt-2'>Review the information, click <strong>Confirm</strong>.</li>
</ul>

<p className='mt-10'><span className="font-bold text-teal">Note:</span> Events uploaded from the website will be marked with a green check. Events uploaded by professors or TAs will be marked with a yellow check. In all other cases, events will not be verified with a check on CMUCal.</p>

</ol>
</div>
)
}




const SupportUserGuide: React.FC = () => {
return (
<div>
<h1>Support User Guide</h1>
<Introduction/>
<div className='flex flex-row'>
<ScrollBar/>
<Content/>
</div>
</div>
)
}
Expand Down
File renamed without changes.

0 comments on commit 01db73b

Please sign in to comment.