anndream / carcv

CarCV - A car recognizing and speed calculating platform

CarCV

A car recognizing and speed calculation platform.

Screenshot

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 semantic versioning.

Building

• See: How-to setup your build environment: Windows, 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 carcv-core demo

Docker

CarCV is also available as a 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 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 planned features

• by translating to a new language

• by 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 issues

• by reviewing patches

Submitting an Issue

We use the 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 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

1. Fork the repository

2. Create a topic branch

3. Implement your feature or bug fix

4. If applicable, add tests for your feature or bug fix

5. Run mvn clean install -Pit

   1. If you contributed to carcv-webapp, run: mvn clean install -Pit,wildfly-it

6. If the tests fail, return to step 3 and 4

7. Add, commit, and push your changes

8. Submit a pull request