baadamczyk / suisen

Open-source manga/anime/VN recommendation engine

standalone-project-template

Template for standalone linux/windows, Java-based projects using Vaadin as a frontend

Build status

Place Your badges here

What Is It All About

More detailed project description

Main features

Feature list

How to run

Step-by-step instructions how to run the application

Version Naming Convention

This project respects version naming convention in following format:

artifactName-X.Y.Z

In application itself it is visible in the following way:

artifactName - v.X.Y.Z

where artifact name is a name of the application - in this case:

where version numbers are:

• X - major release number (ex. complete redesign, visible, large modification of existing component(s))
• Y - minor release number (ex. new functionalities, minor improvements)
• Z - build number

Used Services

This project uses several open-source services to keep it running:

• Travis CI - Continuous Integration tool for this project.
• Codacy - Automatic code review and code quality assurance.
• Sonarcloud - Automatic code review and code quality assurance.
• GitHub Issues - Project tasks management

Authors

• - - <github_name>

See also the list of contributors who participated in this project.

This project is available under the GNU General Public License v3.0 - see the LICENSE file for details.

suisen's Issues

Align project structure

Summary
Project structure, and CI/CD flows needs to be aligned.

Details
N/A

Acceptance criteria

• project compiles successfully
• all placeholders are changed properly
• CI flow works as expected
• static code analysis works as expected
• automatic deployments works as expected

Additional context
Follow up template's TODO list

Implement Main window

Summary
Implement main window as stated in #3

Details
N/A

Acceptance criteria

• main window is implemented
• code is tested
• main window is operational

Additional context
N/A

Design tinder-like matching cards

Summary
Application should give user possibility to cycle through resource matches according to filters/preferences.

Navigation related to cards should be designed in similar way as in tinder.

Acceptance criteria

• resource cycling view
• all functionalities based on tinder design

Additional context
Add any other context or screenshots about the feature request here.

Plan tasks for v. 1.0

Summary
Plan tasks for project

Details
N/A

Acceptance criteria

• tasks are created and assigned to project/milestone

Additional context
N/A

User is able to set weights for each matching strategy

Summary
User should be able to set weights for each matching strategy by entering the settings screen.
Weights should be adjustable by clicking right amount of stars (n out of 5).

Acceptance criteria

• weights for each strategy are available to be set in settings screen
• settings supports modular strategies approach
• strategy weight is visualized as 5 star meter. User has to click the right amount

Additional context
N/A

Design and document main application window

Summary
Main application window should be properly designed.

Details
It is necessary to design and document main application window. Features/controls which should be available for the user in start page have to be determined.

Acceptance criteria

• determine functionalities/controls needed on main page
• document the design

Additional context
N/A

Design cross-matching algorithm

Summary
When user specifies resource (manga, anime, VN, LN) for which equivalent/similar resources are to be found, application should used dedicated algorithm, designed upon love-hate concept.

User should be able to either include or exclude selected matching strategies.

Acceptance criteria
Resources are matched considering:

• same resource categories (manga, anime, VN, LN)
• same author
• same genre
• same tags
• similar tags
• keywords found in descriptions
• user ratings

Other things that needs to be considered:

• weights for each strategy (ex. keywords could be less important than user ratings)
• weights depends on user (user settings)
• user is able to include matching strategies
• user is able to exclude matching strategies
• modular structure

Additional context

• Weights in user settings

Align readme file

Summary
Align template readme to fit the project

Details
N/A

Acceptance criteria

• readme file is aligned and consistent

Additional context
N/A

Application opens in browser after startup

Summary
Application should open in browser right after spring context is initialized

Details
N/A

Acceptance criteria

• browser with main window opens on application startup

Additional context
N/A

Prepare Github Pages

Summary
Clear description or/and business justification of what the task is about.

Details
If applicapable, detailed information regarding things to be considered, requirements etc.

Acceptance criteria

• Github pages are accessible and have the content
• Create 'Design documentation' section
• Create HowTo/Introduction section
• Create 'About' section

Additional context
N/A