Student reports generator is a single page web application written in Angular. It is a tool to aid teachers in writing reports for their students. It allows the teacher to create a (detailed or simple) template to generate a report based on aspects of the student’s learning. The system has a high level of customisability which allows the teacher to design responses for all student types and abilities. The teacher then fills in a questionnaire, based on their template, about each student and a report is generated.
Most browsers don't like referring to other files when you're just viewing a file. This means that you're probably going to need some sort of web server to use this. I recommend node's http-server. If you have npm installed, just run npm install --global http-server and then run http-server from within the project directory.
- This project uses node 6.9.x to manage dev dependencies. Make sure you have this version of node installed
- Run
npm ito install the dev dependencies and build the css. - Run
npm startto start the http server. - Navigate to the url shown in the console.
If you want to recompile the CSS at any point, just run npm run build-css.
This project uses an .editorconfig file to ensure that tabs, line endings etc are kept the same across development environments. You can find a plugin for your text editor here.
This project now uses the SCSS preprocessor to create CSS.
The tl;dr is that you can just write normal CSS, but there are some cool features like variables and nesting
The current build system is Gulp.
You can run gulp to compile the source files.
There is also a scss:watch task that you can run which will compile your changes whenever a scss file is edited.
Why is the compiled CSS included in the repo?
This project is served from the repo using Github Pages and so it needs the compiled CSS to display correctly.