diff --git a/README.md b/README.md index cce66cb7d4..bc0491e91d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ # Student Grade Reporting System Frontend +## By Kwesi Ahenkorah Gyamenah, 11116940 + ## Project Overview This project is a front-end web application for a Student Grade Reporting System. It simulates a real-world application where students can view, report, and manage their academic grades. This system addresses the issue of missing or unrecorded grades in a student's profile. ## Application Structure -The application consists of 7 main pages: +The application consists of 6 main pages: - **Homepage:** Introduction to the system and its purpose. - **Login Page:** Mock login interface for student authentication. - **Dashboard:** Displays an overview of the student’s current grades and alerts for missing grades. -- **Grade Report:** Shows a detailed view of the student's grades filtered by semester or academic year. - **Missing Grade Form:** Enables students to report missing grades. - **Instructor Contact Page:** Lists instructors' contact information with a simulated email feature. - **Help and Support:** Provides FAQs and a mock support contact form. @@ -27,17 +28,30 @@ The application consists of 7 main pages: To set up the project locally, follow these steps: ```bash -git clone https://github.com/your-github-username/DCIT_205_ASSIGNGMENT1.git -cd repo-name +git clone https://github.com/mazza9/DCIT_205_ASSIGNGMENT1.git +cd 11116940_DCIT205_Assignment1 npm install npm start ``` This will start the application on `localhost` at the default port. -## Usage +##Usage + +The App starts in the homepage. There, you can navigate your way to a button saying "Log In to Check Grades". This button, when clicked, leads you to the login page where after a successful login (i.e. when you enter numbers in as student id and pin and submit the form), you are redirected to your dashboard. The Dashboard shows how you're performing, assignment deadlines and most importantly, it shows if any of your grades is missing. If you happen to have missing grades, you can click on "Missing Grades?" in the header to use a form that allows you to report the issue. You can also access the "Instructor Contact Page" by clicking the "Instructors" link in the header. Here, you find a list of instructors' contact information. The simulated email feature allows seamless communication with instructors to discuss grades or seek clarification on academic matters. You can acces this feature by clicking on any of the instructors' contact information.If you encounter any problems while using the application, you can also click the "Help & Support" link in the header. This leads you to a Help page with FAQs and a contact form to submit inquiries and receive assistance from the system administrators. + +##Screenshot +![Screenshot (96)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/99bb4403-2631-48eb-a520-262caa597d48) + +![Screenshot (104)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/84ec7d00-b28a-4dc1-9506-0ff7aff42392) +![Screenshot (103)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/7a0319c2-f1b8-40a4-9833-89b11286061a) +![Screenshot (102)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/a809080b-6a4e-45cb-9e19-a360b7b5659c) +![Screenshot (95)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/db37732a-4025-4e4c-9d69-5b9222aeb620) +![Screenshot (94)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/e096057b-3e02-413b-a44e-b4431c375455) +![Screenshot (93)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/f51c14e2-3ab8-48c5-a8ed-1436bb6e9dbf) +![Screenshot (105)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/337c3f31-9f6e-4adf-af57-2d7621775c36) -Describe how to use the application, highlighting key functionalities such as logging in, viewing grades, reporting missing grades, and contacting instructors. +![Screenshot (101)](https://github.com/mazza9/11116940_DCIT205_Assignment1/assets/149297276/de0eda80-2a31-47b3-a8a1-e7e7677b40b6) ## Contribution diff --git a/dcit-assignment/.gitignore b/dcit-assignment/.gitignore new file mode 100644 index 0000000000..4d29575de8 --- /dev/null +++ b/dcit-assignment/.gitignore @@ -0,0 +1,23 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/dcit-assignment/README.md b/dcit-assignment/README.md new file mode 100644 index 0000000000..c0541f9c04 --- /dev/null +++ b/dcit-assignment/README.md @@ -0,0 +1,70 @@ +# Getting Started with Create React App + +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). + +## Available Scripts + +In the project directory, you can run: + +### `yarn start` + +Runs the app in the development mode.\ +Open [http://localhost:3000](http://localhost:3000) to view it in your browser. + +The page will reload when you make changes.\ +You may also see any lint errors in the console. + +### `yarn test` + +Launches the test runner in the interactive watch mode.\ +See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. + +### `yarn build` + +Builds the app for production to the `build` folder.\ +It correctly bundles React in production mode and optimizes the build for the best performance. + +The build is minified and the filenames include the hashes.\ +Your app is ready to be deployed! + +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. + +### `yarn eject` + +**Note: this is a one-way operation. Once you `eject`, you can't go back!** + +If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. + +Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. + +You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. + +## Learn More + +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). + +To learn React, check out the [React documentation](https://reactjs.org/). + +### Code Splitting + +This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) + +### Analyzing the Bundle Size + +This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) + +### Making a Progressive Web App + +This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) + +### Advanced Configuration + +This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) + +### Deployment + +This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) + +### `yarn build` fails to minify + +This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) diff --git a/dcit-assignment/package.json b/dcit-assignment/package.json new file mode 100644 index 0000000000..3287818ed4 --- /dev/null +++ b/dcit-assignment/package.json @@ -0,0 +1,41 @@ +{ + "name": "dcit-assignment", + "version": "0.1.0", + "private": true, + "dependencies": { + "@testing-library/jest-dom": "^5.14.1", + "@testing-library/react": "^13.0.0", + "@testing-library/user-event": "^13.2.1", + "chart.js": "^4.4.1", + "normalize.css": "^8.0.1", + "react": "^18.2.0", + "react-dom": "^18.2.0", + "react-router-dom": "^6.21.0", + "react-scripts": "5.0.1", + "web-vitals": "^2.1.0" + }, + "scripts": { + "start": "react-scripts start", + "build": "react-scripts build", + "test": "react-scripts test", + "eject": "react-scripts eject" + }, + "eslintConfig": { + "extends": [ + "react-app", + "react-app/jest" + ] + }, + "browserslist": { + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + } +} diff --git a/dcit-assignment/public/favicon.ico b/dcit-assignment/public/favicon.ico new file mode 100644 index 0000000000..a11777cc47 Binary files /dev/null and b/dcit-assignment/public/favicon.ico differ diff --git a/dcit-assignment/public/index.html b/dcit-assignment/public/index.html new file mode 100644 index 0000000000..9d36b661d1 --- /dev/null +++ b/dcit-assignment/public/index.html @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + Missing Grade Reporting System + + + +
+ + + diff --git a/dcit-assignment/public/logo192.png b/dcit-assignment/public/logo192.png new file mode 100644 index 0000000000..fc44b0a379 Binary files /dev/null and b/dcit-assignment/public/logo192.png differ diff --git a/dcit-assignment/public/logo512.png b/dcit-assignment/public/logo512.png new file mode 100644 index 0000000000..a4e47a6545 Binary files /dev/null and b/dcit-assignment/public/logo512.png differ diff --git a/dcit-assignment/public/manifest.json b/dcit-assignment/public/manifest.json new file mode 100644 index 0000000000..080d6c77ac --- /dev/null +++ b/dcit-assignment/public/manifest.json @@ -0,0 +1,25 @@ +{ + "short_name": "React App", + "name": "Create React App Sample", + "icons": [ + { + "src": "favicon.ico", + "sizes": "64x64 32x32 24x24 16x16", + "type": "image/x-icon" + }, + { + "src": "logo192.png", + "type": "image/png", + "sizes": "192x192" + }, + { + "src": "logo512.png", + "type": "image/png", + "sizes": "512x512" + } + ], + "start_url": ".", + "display": "standalone", + "theme_color": "#000000", + "background_color": "#ffffff" +} diff --git a/dcit-assignment/public/robots.txt b/dcit-assignment/public/robots.txt new file mode 100644 index 0000000000..e9e57dc4d4 --- /dev/null +++ b/dcit-assignment/public/robots.txt @@ -0,0 +1,3 @@ +# https://www.robotstxt.org/robotstxt.html +User-agent: * +Disallow: diff --git a/dcit-assignment/src/App.css b/dcit-assignment/src/App.css new file mode 100644 index 0000000000..9e8748668b --- /dev/null +++ b/dcit-assignment/src/App.css @@ -0,0 +1,17 @@ +body{ + font-family: 'Poppins', sans-serif; + margin: 0; + padding: 0; + display: flex; + align-items: center; + justify-content: center; + background-image: url('./components/img/landing-page-bg.jpeg'); + background-repeat: no-repeat; + background-size: cover; +} + + +@keyframes fade-in { + from {opacity: 0;} + to {opacity: 1;} +} diff --git a/dcit-assignment/src/App.js b/dcit-assignment/src/App.js new file mode 100644 index 0000000000..95ec2029b1 --- /dev/null +++ b/dcit-assignment/src/App.js @@ -0,0 +1,33 @@ +import React from 'react'; +import './App.css' +import Navbar from "./components/Navbar"; +import HelpAndSupport from './components/HelpAndSupport'; +import MissingGradeForm from './components/MissingGradeForm'; +import Dashboard from './components/Dashboard'; +import LandingPage from './components/LandingPage'; +import { Route, Routes } from 'react-router-dom'; +import InstructorContactPage from './components/InstructorContactPage'; +import LoginPage from './components/LoginPage'; + + + +const App = () => { + return ( +
+ +
+ + } /> + } /> + } /> + } /> + } /> + } /> + } /> + +
+
+ ) +} + +export default App \ No newline at end of file diff --git a/dcit-assignment/src/components/ContactForm.js b/dcit-assignment/src/components/ContactForm.js new file mode 100644 index 0000000000..cfd93c8d71 --- /dev/null +++ b/dcit-assignment/src/components/ContactForm.js @@ -0,0 +1,67 @@ +import React, { useState } from 'react'; + +const ContactForm = () => { + const [formData, setFormData] = useState({ + name: '', + email: '', + message: '', + }); + + const handleChange = (e) => { + const { name, value } = e.target; + setFormData({ ...formData, [name]: value }); + }; + + const handleSubmit = (e) => { + e.preventDefault(); + console.log('Form submitted:', formData); + setFormData({ name: '', email: '', message: '' }); + }; + + return ( +
+
+
+

Contact Technical Support

+ + + + + + + +