Web application for Dreadball.
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:
mvn verify site -P h2,jetty
The verify phase is required, as otherwise some of the reports won't be created.
The application is coded in Java, using Maven to manage the project.
The project has been tested on the following Java versions:
- JDK 8
All other dependencies are handled through Maven, and noted in the included POM file.
The project can be installed by creating the war file and deploying it into a server.
To run the project locally in an embedded server just use the following Maven command for Jetty:
mvn jetty:run-war -P h2,jetty,db-properties,development
Or this one for Tomcat:
mvn tomcat7:run-war -P h2,tomcat7,db-properties,development
After this the project will be accessible at [http://localhost:8080/].
The integration tests require a database and a running server, and the easiest way to run them is in a similar way to running the project locally.
To run the tests with Jetty:
mvn verify -P h2,jetty,db-properties,development
To run them with Tomcat:
mvn verify -P h2,tomcat7,db-properties,development
Maven will run both the frontend and backend tests.
To run only the frontend tests:
npm run test
When creating the WAR file the database connection credentials should be read from the environment:
mvn package -P production,mysql -D database.auth.source=env
Check the documentation for more information.
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
The project has been released under the MIT License.