meet59patel/schooler

Schooler - Academics Manager

schooler's Issues

[Issue for All] Fork the repo and deploy to vercel

• Fork this repository and deploy your forked version using vercel
• This issue is for EVERYONE participating in SLoP under Schooler
• Everyone finishing this deployment will get 5 SLoP points

Remove Sidebar documentation links

Remove these links from sidebar:

• Add GitHub Repository link here with Github icon

[Documentation] Add contributions guidelines and Issue templates

Contributing guidelines

• Should list out all the rules shared by @meet59patel in the gitter chat
• Think for more rules if necessary
• All of these contribution guidelines to be saved as CONTRIBUTING.md
• For reference: Reference 1, Reference 2
• Also add little git guide like this:

---

Issue Templates

• All the documentation must be in Markdown format
• Issue templates for
  • Bug report
  • Feature request
• One issue template for example:
  

[Dashboard] Show online friends list

• Change this card to incorporate this change

• This card should a show currently online friends list with a green dot on side
• You're required to make a React component for this task

[Backend] Make Assignment Schema for MongoDB

• Refer to the issue here: meet59patel/schooler-server#4
• Make a MongoDB model (schema) to store Assignments for courses

[Attendance] Attendance page

• This component will used inside Attendance page

• Make new page component inside schooler/src/views/examples/ directory, Named Attendance.js
• Have a dummy object variable that holds attendance data
• Inside this, you'll make a Course attendance card component that will be used to form a grid
• This component should contain info like Total days, Attended days, percentage according to that, course name, instructor name
• This Attendance page will have different cards for different courses that show above listed information
• These cards would be in a grid, just for an idea of structure a screenshot is attached:

Update favicon & <meta> tags

• Update favicon.ico

• Add <meta> tags if needed (research and suggest) - For reference, check: HTML Head Boilerplate & Reference

Change client side routing

Currently the Routes are of the form https://schooler.vercel.app/admin/index .
We require to change these routes in this manner:

• Remove /admin/ subpath from everywhere
• Make the dashboard path as /dashboard instead of /admin/index
• After the changes the routes should be like:
  • https://schooler.vercel.app/dashboard
  • https://schooler.vercel.app/timetable
  • ... similar like this from given list: /schedule, /attendance, /assignments, /storage,/grades, /reminders, /quicknotes

[feature] Add @all-contributors Bot 🤖

• Read the documentation available at: https://allcontributors.org/docs/en/specification
• make .all-contributorsrc
• make necessary changes in README.md
• Reference: .all-contributorsrc (DO NOT COPY the contributors list from this file)
• Bot should be configured to add contributors in this fashion

Hints: Use these configuration variables:

• "projectName": "Schooler",
  "projectOwner": "meet59patel",
  "imageSize": 100,
  "commit": false,
  "skipCi": true

Make attendance component

• Replace this card from dashboard:

• Make disk/circular progress of attendance in this card

Update Menu (Sidebar)

These NavLinks should be there

• Dashboard
• Time table (Here goes Calendar as well)
• Schedule
• Attendance
• Assignments
• Storage
• Grades
• Reminders
• Quick Notes

In place of these links:

[Dashboard] Calendar component

• Replace this card to have a calendar:

• This will be a Daily view - which shows today's labs and lectures
• Each list item to have check-boxes so that attendance for that day can be marked for that subject
• Column names: Subject name, professor name, timing, checkbox of attendance
• You're required to make a React component for this task

[Dashboard] Recently accessed documents

• Update this card to show the list of recently accessed documents

• Recently accessed documents
• You're required to make a React component for this task

[Refactor] Pages folder rename

• Change this folder name examples to Pages, We're refering to this folder path: schooler/src/views/examples/
• Change all the import paths throughout the repository wherever these components are imported
• The app should work just like before - it's just a refactor

Secure backend API routes with authentication

• Use JWT
• Google sign in returns JWT token, frontend sends that JWT to backend, verify if this JWT token is actually from Google or not using their API: https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=YOUR_TOKEN_HERE
  • There are ways other than using this Google API, do research for them and find best option first.
• Make middleware checks to secure routes

Backend Repository: meet59patel/schooler-server

Update dashboard small cards at top

Think and discuss about this before finalizing titles to these fields

• Keep the predefined cards structure but it'll have information like "No assignments due", "No Submissions due" etc.

• These cards are being referred here:

Add Timetable functionality

• Add calendar support
• Use MomentJS or similar library to handle temporal transactions
• Add Dates/Holidays model for MongoDB (if needed)

[Top Navbar] Change the user name dynamically

• Get the value of Name and User's profile picture URL from Google Authentication response
• Set the name and image here: (accessible from AdminNavbar.js)

• Need to use React Context to implement this
• Look for UserProvider inside src/context/UserContext.js
• Set a new name attribute and profileImage that stores image URL

Remove Registration links

• On login screen: remove Register button on top right
• In dashboard sidebar remove Register link
• Remove Register code/components from everywhere in code

[Courses] Make courses list component

• Make new component inside schooler/src/views/examples/ directory, Named Courses.js
• Have a dummy course object inside the component which contains details of that course
• For reference, do check out other components available inside the same folder
• Use object schema available here to know which values you need to store in the course object: https://github.com/meet59patel/schooler-server/blob/master/Models/Course.js
• Make a new link inside the left navigation bar named Courses that lists all the courses using this component
• Have basic CSS for now

[Backend] Make Attendance Schema for MongoDB

• Refer to the issue here: meet59patel/schooler-server#3