base.camp Luftdaten Frontend

This web app uses sensor data from the openSource project luftdaten.info to predict particulate matter development for Germany. The project was implemented as part of the base.camp of the Department of Computer Science at the University of Hamburg.

Setup

To start developing, there are two options to get the project up and running:

1. via Docker

   This requires you to have docker-compose installed locally.

   Run the following commands to start a local development server:

   docker-compose build --no-cache web
   docker-compose up

   The first command will have to be re-run every time a dependency changes.

2. via Node.js directly

   For this option, you need Node.js and npm installed on your machine. (npm usually gets installed along with Node.js).

   Once you did that, run

   npm install

   to install all dependencies and

   npm start
   

   to start the development server.

Build

To create a production build, you have two options again:

1. If you've set up the project using Docker:
   1. Delete the dist directory if it exists.
   2. Execute docker-compose exec web npm run build while the container is running.
2. If you've set up the project using npm directly:
   1. Delete the dist directory if it exists.
   2. Execute npm run build.

The generated HTML/CSS/JavaScript files should now be in the dist directory.

Contributing

To contribute please follow these few steps:

1. git checkout master
2. git pull
3. git checkout -b <branch-name>
4. npm install
5. npm start
6. Apply your changes
7. git add .
8. git commit -m "commit message"
9. git push -u origin <branch-name>
10. Go to GitHub and open a pull request

Running tests

To run all tests, use

npm test

Or, to have the tests run in watch mode (re-run every time the test/source files are changed), use:

npm test -- --watch