Locomotor is a real and fictional vehicles comparator. It is based on predefined criterias that the user can select. It outputs a list of the vehicles that fit "the most" the user's query. The comparator works in a client/server design, allowing multiple users to use the same dataset at the same time.
The project offers 2 clients:
- the first one is an administation interface which allow the user to modify the dataset.
- the other is an easy to use interface enabling the user to search for a vehicle and retrieve his booking.
A presentation of the project is available in French.
These instructions will get you a copy of the project up and running on your local machine.
A wiki is also available, and give and more technical insight of the project: architecture, API, comparison algorithms, etc.
Note: this project does not compile under Windows environment.
To run this project, you will need :
To build this project, simply clone this repository and build the project.
git clone https://github.com/gaelfoppolo/locomotor
cd locomotor
make allTo run the application, you need to start the core first.
make run-coreThen, you can choose the interface to use:
| User | Admin |
|---|---|
make run-front-user |
make run-front-user —admin |
If you want to use a prefilled database, use the ones in the data directory.
To import use:
make import-databaseThe images of the vehicles are not provided, but you can easily find them on the Internet.
To check that your code is compliant with our coding convention without having to compile the project, use:
make linterA documentation is also available, with graph to a better understanding of our process.
You can also build it on your own, just make sure you have installed Doxygen and Graphviz.
Then browse to the root of the project folder and run:
make docSee makefile for further explanations.
- Bastien Philip - Initial work - ebatsin
- Gaël Foppolo - Initial work - gaelfoppolo
This project is licensed under the GPLv3 license, see LICENSE.md.