ARC is a one-stop web application designed to meet the academic needs of students, providing a convenient platform to manage study plans, calculate grades, and check degree requirements. The platform aims to streamline academic processes, allowing students to focus on other important aspects of university life. It is accessible here: https://arc123.netlify.app.
ARC is a web application with the following key features:
Users can enter their module assessment scores and calculate their overall scores. The calculator will display the scores needed to achieve the desired grade.
Users can plan their modules for multiple semesters, adding and removing modules as needed. The platform will support different degree programs and update the degree requirement tables accordingly.
ARC will include a forum where students can share their study plans with others, fostering collaboration and providing valuable references for academic planning.
The profile page in ARC serves as a central hub for users to manage their account information and settings. It provides users with the ability to update their user properties and make changes to their account details.
The feedback form in ARC allows authenticated users to submit feedback, bug reports, or issues by clicking a button located at the bottom right of any page, which opens a form for users to type their feedback and submit it.
The test plan for ARC ensures the quality and reliability of the application through three main types of tests: system testing, integration testing, and unit testing. System tests cover the complete user flow using Puppeteer, while integration tests verify interactions between components with the help of MockProvider and mockStore for isolation. Unit tests use Jest and @testing-library/react for UI and Firebase backend testing, with Jest-Environment-JSDOM providing the simulated DOM environment.
System Tests: Puppeteer, Local Firebase emulator server, Axios Integration and Unit Tests: Jest, @testing-library/react, jest-environment-jsdom, MockProvider, mockStore, MockFirebase, MockFirestore The test suite covers various scenarios and ensures thorough testing of the core functionalities, combining different testing methodologies for comprehensive coverage and early bug detection.
To run ARC locally on your machine, follow these steps:
- Clone the repository:
[git clone https://github.com/ruishanteo/arc - Install the necessary dependencies:
yarn install - Start the development server:
yarn start - Open your browser and navigate to
http://localhost:3000to access ARC.
- React.js: Frontend development framework.
- MUI: Frontend component library.
- Formik, Yup: Form building and input validation.
- Firebase: Database for storing user data.
- Netlify: Deployment of project.