Contact Manager

View Demo (TODO) · Get latest release

Table of Contents

1. About The Project
2. Context
3. Built With
4. Documentation
5. Getting Started
6. Contributors

About The Project

This project principle is simple: an application to manage a list of contacts and their interactions such as todos. This application could be used in a company context for example.

Features

• Manage a list of contacts (name, email, company, etc.).
• Manage the tasks of a contact (description, deadline).
• Find contacts with multiple search filters.
• Perform an advanced search with a query system.
• Export contacts in JSON format.

(back to top)

Context

This project is an academic project made during the third year of a Bachelor of Computer Science.
The development was done by 2 people.

(back to top)

Built With

Entire project was built with C++ for the business layer and Qt for the storage and UI layers. Database used is SQLite.

(back to top)

Documentation

You can find documentation files such as the requirements analysis, UML diagrams in the folder docs/.
Doxygen docs can be generated in HTML with script file doxy/run_doxygen (Doxygen must be installed on your system).

(back to top)

Getting Started

If you are on Windows x64, and don't want to compile, you can get latest binaries and skip the next steps.
Anyways, to get a local copy up and running follow the steps:

Prerequisites

To setup the project, you will need:

• Qt 5.0+

Installation

1. Clone the repo:

   git clone https://github.com/Akwd22/contact-manager.git

2. Compile the project, you have two choices:

   • From command-line:

     cd src
     qmake
     make <debug|release>

     Then, go to src/out/<debug|release> and run ui executable to run the app, or test_logic if you want to run unit tests.

   • From Qt Creator: import the project file src/main.pro with default settings, and you should be good.

(back to top)

Contributors

This project was made by:

• Eddy D.
• Clément G.

(back to top)