Abc-teacher-report NPM

Teacher report UI

This folder includes the frontend for teacher report of ABC project using Next.js.

Getting Started

Prerequisites

You will need Node and npm for this project. If you do not have them installed on your machine, you may follow the instructions here for installation.

Installing

Run the following to install the dependencies of the project.

npm i

Run locally

Start the server by running command below. Visit http://localhost:3000/ when it is up.

npm run dev

Directory Structure

.
|-- components
|   |-- Component
|   |   |-- index.js            # component definition
|   |   |-- Component.scss      # component style file
|   |-- ...
|-- pages
|   |-- index.js                # index UI
|   |-- index.scss              # index style file
|-- .npmignore
|-- next.config.js              # Next.js config
|-- package.json
|-- package-lock.json
|-- postcss.config.js
|-- server.js
|-- README.md

Build static HTML file

Run following to generate and deploy the updated HTML file.

npm run build

Build version will be updated automatically and the SCSMCPS_TEACHER_REPORT_HTML_TEMPLATE_STR under chalicelib/html_template.py will be updated from the copy of dist/index.html to serve the new report UI. Noted that this has to be run in /teacher_report_ui folder.