Air Bed and Bug (Airbnb)

This is our project for course GLO-2003 at Laval University. We are team 8.

Requests supported by the Airbnb API are specified on this project's GitHub Pages.

Documentation about what must be achieved by this app is documented in /resources.

Our project is hosted on https://glo2003-h2020-eq08.herokuapp.com.

Project setup

Install dependencies and build project

Maven is used as a built automation tool, as well as a dependency manager. To build the application, use :

mvn clean install

Execute app

To execute the application, use :

mvn exec:java

The app will be running on http://localhost:4567.

Run tests

Tests are located in src/test/java/ca/ulaval/glo2003. They are all checked pre-commit and during the CI pipeline. Coverage report are generated using Jacoco during the report built phase.

To run unit tests, use :

mvn surefire:test

Apply code style

Code style is verified pre-commit. To apply Google Java Code Style throughout the source code, use :

mvn git-code-format:format-code -DglobPattern=**/*

API documentation generation

As said above, all requests for this app are listed on our GitHubPages. We used RAML 1.0. To render documentation, you must install npm dependencies and start the script :

cd /docs
npm install
npm start