== CarCV

image:https://github.com/oskopek/carcv/workflows/Java%20CI%20with%20Maven/badge.svg["build status", link="https://github.com/oskopek/carcv/actions?query=workflow%3A%22Java+CI+with+Maven%22"]

A car recognizing and speed calculation platform.

=== Modules CarCV consists of several modules:

• carcv-core -- core detection and recognition module
• carcv-cpp -- an old and deprecated implementation of this project in C++ with heavy use of OpenCV
• carcv-webapp -- a Java EE web-app implementation of the CarCV Core

CarCV uses http://semver.org/[semantic versioning].

=== Building

• See: How-to setup your build environment: link:./docs/howto-setup-environment-windows.adoc[Windows], link:./docs/howto-setup-environment-linux.adoc[Linux & Mac]
• Recommended: mvn clean install -DskipTests
• To run unit tests: mvn clean install
• To run integration tests: mvn clean install -Pit,wildfly
• To clean, run: mvn clean
• Run a simple link:./docs/core/core-usage.adoc[carcv-core demo]

=== Docker CarCV is also available as a https://registry.hub.docker.com/u/oskopek/carcv-webapp/[Docker image]:

sudo docker pull oskopek/carcv-webapp
sudo docker run -d --name=mariadb fedora/mariadb
sudo docker run -it --rm --link mariadb:mariadb -p 8080:8080 oskopek/carcv-webapp

=== Getting help

• Post questions or comments on our Google Groups link:https://groups.google.com/d/forum/carcv[mailing list]
• Join our IRC channel: Join #carcv on irc.freenode.net

=== Contributing Everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using alpha, beta, and pre-release versions
• by reporting bugs
• by suggesting new features
• by implementing link:./docs/goals.adoc[planned features]
• by translating to a new language
• by link:./docs/howto-write-documentation.adoc[writing or editing documentation]
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by closing https://github.com/oskopek/carcv/issues[issues]
• by reviewing patches

=== Submitting an Issue We use the https://github.com/oskopek/carcv/issues[GitHub issue tracker] to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a https://gist.github.com/[Gist] that includes a stack trace and any details that may be necessary to reproduce the bug, including your Java version and operating system.

=== Submitting a Pull Request . http://help.github.com/fork-a-repo/[Fork the repository] . http://learn.github.com/p/branching.html[Create a topic branch] . Implement your feature or bug fix . If applicable, add tests for your feature or bug fix . Run mvn clean install -Pit .. If you contributed to carcv-webapp, run: mvn clean install -Pit,wildfly-it . If the tests fail, return to step 3 and 4 . Add, commit, and push your changes . http://help.github.com/send-pull-requests/[Submit a pull request]