weclaw1 / aws_tsp Goto Github PK

Spark is a micro framework for creating web services. It will be used for creating REST API.
Dependency can be found here:
https://mvnrepository.com/artifact/com.sparkjava/spark-core/2.5.5

Implement REST API from the project diagram.

Documentation can be found here - https://github.com/iwongu/sqlite3pp
Create implementation for SQLiteDAO.
I already added SQLite and a nice wrapper called sqlite3pp.

For creating documentation you can use one of the following projects:
https://github.com/lord/slate
http://swagger.io/
http://www.raml.org/

Learn about designing RESTful APIs at: http://www.restapitutorial.com/

API should use HTTP methods GET, POST, PUT and DELETE

Create tests for SQLiteDAO, REST Api and JsonConverter.
You can check how to write tests in tests.cpp in test folder.

Implement frontend which will communicate with the rest apu on the server.
I'm leaving the choice of libraries up to you.
If you want any recommendations or help leave me a message.

Create AbstractDAO for saving results

AbstractDAO has to be created first

Create task receiver. Use ZeroMQ as server with socket type with socket type REP. Listen on port 9999.

Travis is a CI service that has good integration with github and is free for public projects.
It will build and test push requests.

TSPResultAnalyzer should check if total distance is smaller than specified distance. It would be nice if total distance could be selected automatically based on the received graph.

Implement Abstract Validator Factory and Json10Validator from the diagram. You also need to define the JSON format for task data.

Documentation for library can be found here: https://github.com/nlohmann/json
Implement methods fromJson and toJson for Task and TaskResult in task.h, you will also need to implement those methods for WeightedGraph in weightedgraph.h.
JsonConverter should also check if graph is valid.

Create documentation for using git and project workflow - creating branches and making pull requests

You can use .gitignore files from: https://github.com/github/gitignore

Java project should use Gradle and Java gitignore files.
C++ project should use CMake and C++ gitignore.

Define protobuf task format, which will be shared between the java and c++ programs.

Create general architecture diagram, UML diagram should be created later.

Task sender uses ZeroMQ for sending messages. Use ZeroMQ in client mode with REQ socket type on port 9999.