Project for COMS W4156

Members:

Group Name: lqxx

Language & Platform: C++ & Ubuntu 20.04 LTS / 22.04 LTS

Github: https://github.com/xxcisxxc/lqxx4156

Our service is used for task management. Users can create their own task lists, add tasks into lists, and view and manage the tasks. Multiple users can have their own task lists. Different users can share their own task lists so that multiple users can cooperate on one task lists.

# Step 1: Install Environment
./build.sh install

# Step 2 (optional): Run all the tests
./build.sh test

# Step 3: Compile
./build.sh build

# Step 4: Run service in the background
./build.sh run

https://lqxx4156.tk/ (Inaccessible after 12/19/2022)

https://xxcisxxc.github.io/client/ (Inaccessible after 12/19/2022)

https://app.swaggerhub.com/apis-docs/lqxx4156/Task-Management/v1

See badges at the top. Note that lint checking includes format checking and static analysis.

We use clang-format for format checking and cppcheck for static analysis. For the result, please see the lint-checking badge.

We use gcov for coverage. Please see the report in Coverage in github actions.

Please refer to .gitmodules to get their file positions and source.

We use graph database neo4j as backend. However, trying to connect to database is really annoying. The widely used neo4j C driver totally does not work for the new version neo4j. Here we use this library, which tries to merge into that driver (not yet) and supports part of neo4j connection protocol.

At first, we just use IP address to connect our service. We start to think how to support SSL because when deploying our service, secure link is unable to send query to insecure server.

First, you need to register a domain and add your server IP address to the list.

Then, you need to get a certificate, we use this link

Finally, SSL usually supports by your library and you will need the private keys you just generated. Here is an simple example.