npmto install the required packages
- Python 3.6 in case you want to download the latest data
For installation, clone the repository first.
git clone https://github.com/eliashaeussler/student-growth.git cd student-growth
After cloning install the Node dependencies:
You can also use
npm install in case you haven't installed
Build the site
In order to access the website which shows the visualization, you need to build the necessary project files:
yarn run build
You can alternatively use
npm run-script build or
gulp --production && gulp server.
This compiles all necessary files and places them inside a
dist folder. Files from this folder will be used as source
for a web server which automatically starts running when you run one of the above commands.
If your Browser does not open by it's own, open it manually and navigate to the following page:
8000 is already in use, BrowserSync tries to use the next available port. You can see the active port in your
command line after running one of the above commands.
yarn run start
npm start or simply
The Development mode allows you to see changes on project files immediately in your browser since BrowserSync is watching for changes.
||Build only the source files and does not start the server|
||Run the server without creating any source files|
||Run the server without creating source files and watch for changes|
||–||Test the project (does not start the server)|
npm scripts need to be executed using
yarn run <command> or
npm run-script <command>.
When running Gulp tasks, execute them using
Download the latest data
The necessary data has already been downloaded and is included in this repository. You can always download the latest data
using the available download script (note that it's required to have
python3 installed for this):
After a few seconds you will see something like this:
Downloading: Studierende: Bundesländer, Semester, Nationalität, Geschlecht Download successful: src/data/data.csv
data/source.json contains important information which are being used to parse the remote source file correctly.
||File which contains information about the source files and their file formats||Valid URL with protocol as string|
||Position of keys (headlines) inside the source file (X and Y)||Object with keys
||Position of first and last data row||Object with keys
Installing certificates on macOS
If you are working with macOS, you might run into trouble when running the python script. You might get an output like this:
<urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:749)>
In this case, you need to install additional certificates. The installation script is installed inside your Python application
Applications/Python 3.6/Install Certificates.command. It installs
certifi on your system which is needed
to handle secure remote connections.
- dataBundesLander.json by oscar6echo
- 21311-0005.csv (modified) by the Federal Statistical Office of Germany
- SpinKit by Tobias Ahlin