Yann.chi

README.md

@@ -1,36 +1,108 @@
-# Note Application
+# Chess Puzzles
 
-This is a minimal example demonstrating usage of the
-password-protected user part of the API used in lab 5.
+## Team Members
 
-You can find more information about the API endpoints in
-[the documentation](https://www.postman.com/cloudy-astronaut-813156/csc207-grade-apis-demo/documentation/fg3zkjm/5-password-protected-user).
+Chihana Kashiwabara - unomaru
 
-If your team is considering an application for which it would be convenient to
-store data in something like a database, you may find that the API calls demonstrated
-here will be useful in your project, as this will allow you to store
-an arbitrary JSON object associated with a username and password.
+Jiaqi Ma - DDMMMAA
 
-In this application, a single note has a name (the "username" in terms of the API) and the note
-can be read by anyone who knows the name — but only edited by someone who
-knows the password for it.
+Michelle Bakman - 207moment
 
-You can see the documentation in the various files for more information.
+John Ding - J0hnDing
 
-## Testing
+Yann Chi - YannChi22
 
-The repo also includes an example of a use case interactor test, as well as
-an example of an end-to-end test which automates button clicks and inspects
-the contents of the actual views. This is something we discussed in the lectures
-about testing in CA but had not provided a code example of before. Note, one
-could also inspect the contents of the ViewModel objects instead when testing
-CA to make a similar test which would be less dependent on the details of the
-specific UI implementation.
+## Table of content
 
-## Project Starter Code
++ [About This Project](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#about-this-project)
++ [Installation](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#installation)
++ [Use Case (Feature)](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#use-cases-features)
+    + [Signup & Login](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#signup--login)
+    + [Show Profile](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#show-profile)
+    + [Generate Daily Puzzle](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#generate-daily-puzzle)
+    + [Step by Step Move](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#generate-daily-puzzle)
++ [Usage Guide](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#usage-guide)
++ [Feedback](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#feedback)
++ [Contribute to this project](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#this-project-is-close-for-contributions)
++ [User Stories](https://github.com/DDMMMAA/CSC207-Team179?tab=readme-ov-file#user-stories)
 
-Your team may choose to use this repo as starter code for your project. You could
-also use the lab 5 code — or start from an empty repo if your team prefers.
 
-If you choose to use one of the repositories we have provided, you can either make
-a fork of it or copy the subset of code you want into a completely new repository.
+## About this project
+
+This app/project is able to generate random chess puzzles with options for daily, random puzzles, or specifically themed puzzles.
+A user will be able to view their puzzle statistics or review past puzzles within the current session of the program.
+Users should have the option to log in or create an account [built into the lichess api].
+If a user is logged in, they should be able to access any past puzzle scores or game histories they’ve played on that account.
+
+## Installation
+
+To Start: Clone ```main``` branch into your favorite JAVA IDE, then run ```MainChessAPP.java``` in ```src/main/java/app```
+```
+git clone https://github.com/DDMMMAA/CSC207-Team179.git
+```
+
+To close: Left click ```X``` icon at top right.
+
+Note: No additional package needed
+
+## Use Cases (Features)
+
+
+
+
+### <ins>Signup & Login</ins>
+
+This feature allows users to signup by creating username and password and login to the account created.
+
+To Signup: Enter username and password(two times) to be used for an account, and click ```Signup``` to confirm signup.
+
+To Login: Click ```Login``` to navigate to a login page, enter username and password for the account, and click ```Login``` to confirm login.
+
+
+### <ins>Show Profile</ins>
+
+User can view their profile (Contain User name and rank point currently) after login by click ```Show Profile``` after login.
+
+Note: New user's rank point is set to ```0``` 
+
+![Show Profile](https://github.com/DDMMMAA/CSC207-Team179/blob/main/Show%20Profilegif.gif?raw=true)
+
+
+### <ins>Generate daily puzzle</ins>
+
+This requests the algebraic chess notation for the current daily puzzle in the Lichess API
+and stores the set of solutions and the series of moves to create the puzzle board.
+
+### <ins>Step by step move</ins>
+
+This feature enables users to move a chess piece to a valid position during their turn. 
+Since moving a piece involves two steps, select and move, this usecase have two functionality.
+
+To Select: User clicks on the square containing the chess piece they want to select. The program then highlights all valid moves in yellow.
+
+To Move: If one piece is selected and the user clicks on one of the highlighted squares, the chess piece is moved to the target position.
+
+Note: Clicking an invalid move after select deselects the piece.
+
+## Usage Guide
+
+This meant to me used in order of ```Signup & Login``` &rarr; ```Generate daily puzzle``` &rarr; ```Step by step move```
+(Please refer to above ```use cases (Features)``` for detail of each use case)
+
+## Feedback
+
+Plead use github [Discussion board](https://github.com/DDMMMAA/CSC207-Team179/discussions) to submit your feedback.
+
+Simply start a new discussion with appropriate title (eg., associated use case).
+
+## This project is close for contributions
+
+## User Stories
+
+Group User Story. Tom generate a chess puzzle, solve it step by step, and eventually win.
+
+1. John wants to play a chess puzzle. He opens the chess puzzle player and clicks generate puzzle of the day. The chess puzzle of the day loads on screen. [Michelle’s Story]
+2. Tom and Tim argued about who is a better chess player, so they decided to compare their Rank point of Ranking system. [Jiaqi Ma’s Story]
+3. As Mary hears about this chess puzzle, she wants to create an account and log in to start a puzzle. [Chihana’s Story]
+4. Andy is learning chess, and he can use this program to check his learning progress, by looking at past statistics of chess puzzles. He can search up his user account using the username. [Yann Chi's Story]
+5. Felix wants to see the possible moves he can make with one piece, so he click on that piece and the possible cells will be indicated. [John’s Story]

accessibility-report.md

@@ -0,0 +1,22 @@
+## Principle of Universal desgin
+
++ Equitable Use
+  + Users are allowed to input any String as their username, not restricted to english. User with none english name can benefit from this.
++ Flexibility in Use
+  + Features could add: Allowed user to pick board theme (ie., Black/white, light theme, dark theme).
++ Simple and Intuitive Use
+  + Move use are match with intuition. Click a piece to select, slick a grid to move
++ Perceptible Information
+  + This program can't accommodate user with visual disability currently. A potential feature might add to accommodate visual disability is allowed user to select other output device (ie., touch board)
++ Tolerance of Error
+  + Tolerating wrong click on grid that doesn't contain piece. Error message like "Can't select empty grid" doesn't sent, because click on empty grid is common that sent error message everytime wrong click happened will be annoyed.
++ Low Physical Effort
+  + The only interaction use need while play the chess game is clicking mose.
++ Size and Space for Approach and Use
+  + Size of the window (chess board) is adjustable.
+
+## Program Market
++ If I were to market my chess puzzle program, I would target chess enthusiasts and learners of all ages, particularly those seeking to improve their strategic thinking and problem-solving skills. The program would appeal to students and educators looking for engaging tools to teach or practice chess fundamentals, as well as casual players who enjoy the intellectual challenge of solving puzzles in their leisure time. Additionally, the program could attract competitive chess players aiming to refine their tactics through a curated collection of puzzles ranging from beginner to advanced levels.
+
+## People who can't take advantage of this App
++ People with dysgnosia is less likely to take advantage of this App, simply because this App is meant to be intellectually challenging. However, puzzle difficulty classification feature can be added and might accommodate people with dysgnosia.

pom.xml

@@ -27,6 +27,16 @@
             <version>4.13.1</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.github.tors42</groupId>
+            <artifactId>chariot</artifactId>
+            <version>0.1.10</version>
+        </dependency>
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>fastjson</artifactId>
+            <version>1.2.79</version>
+        </dependency>
 
     </dependencies>
 

src/main/java/app/ChessAppBuilder.java

@@ -0,0 +1,67 @@
+package app;
+
+import data_access.ChessDataAccessObject;
+import entity.Board;
+import entity.Game;
+import interface_adapter.ViewManagerModel;
+import interface_adapter.move.MoveController;
+import interface_adapter.move.MovePresenter;
+import interface_adapter.move.MoveViewModel;
+import use_case.move.MoveInteractor;
+import use_case.move.MoveOutputBoundary;
+import view.ChessBoardView;
+
+/**
+ * Builder for the Chess Application.
+ */
+public class ChessAppBuilder {
+    public static final int HEIGHT = 800;
+    public static final int WIDTH = 800;
+    // TODO change to ChessDataAccessInterface once implemented
+    private ChessDataAccessObject chessDataAccessObject;
+    private MoveViewModel moveViewModel = new MoveViewModel();
+    private final ViewManagerModel viewManagerModel = new ViewManagerModel();
+    private ChessBoardView chessBoardView;
+    private MoveInteractor moveInteractor;
+
+    /**
+     * Set the ChessDAO to be used in this application.
+     * @param chessDataAccess the DAO to use
+     * @return this builder
+     */
+    public ChessAppBuilder addChessDAO(ChessDataAccessObject chessDataAccess) {
+        chessDataAccessObject = chessDataAccess;
+        return this;
+    }
+
+    /**
+     * Creates the objects for the Move Use Case and connects the ChessBoardView to Move controller.
+     * @return this builder
+     */
+    public ChessAppBuilder addMoveUseCase() {
+        final MoveOutputBoundary moveOutPutBoundary = new MovePresenter(moveViewModel, viewManagerModel);
+        Board board = new Board();
+        Game game = new Game(board, true);
+        moveInteractor = new MoveInteractor(
+                chessDataAccessObject, moveOutPutBoundary, game);
+
+        final MoveController moveController = new MoveController(moveInteractor);
+        chessBoardView.setMoveController(moveController);
+        return this;
+    }
+
+    /**
+     * Creates the ChessBoardView and underlying MoveViewModel.
+     * @return this builder
+     */
+    public ChessAppBuilder addMoveView() {
+        moveViewModel = new MoveViewModel();
+        final MoveController moveController = new MoveController(moveInteractor);
+        chessBoardView = new ChessBoardView(moveViewModel, moveController);
+        return this;
+    }
+
+    public ChessBoardView buildChessBoardView() {
+        return chessBoardView;
+    }
+}

src/main/java/app/LoginUseCaseFactory.java

@@ -0,0 +1,61 @@
+package app;
+
+import interface_adapter.ViewManagerModel;
+import interface_adapter.logged_in.LoggedInViewModel;
+import interface_adapter.login.LoginController;
+import interface_adapter.login.LoginPresenter;
+import interface_adapter.login.LoginViewModel;
+import interface_adapter.signup.SignupViewModel;
+import use_case.login.LoginInputBoundary;
+import use_case.login.LoginInteractor;
+import use_case.login.LoginOutputBoundary;
+import use_case.login.LoginUserDataAccessInterface;
+import view.LoginView;
+
+/**
+ * This class contains the static factory function for creating the LoginView.
+ */
+public final class LoginUseCaseFactory {
+
+    /** Prevent instantiation. */
+    private LoginUseCaseFactory() {
+
+    }
+
+    /**
+     * Factory function for creating the LoginView.
+     * @param viewManagerModel the ViewManagerModel to inject into the LoginView
+     * @param loginViewModel the LoginViewModel to inject into the LoginView
+     * @param loggedInViewModel the LoggedInViewModel to inject into the LoginView
+     * @param userDataAccessObject the LoginUserDataAccessInterface to inject into the LoginView
+     * @param signupViewModel the SignupViewModel to inject into the LoginView
+     * @return the LoginView created for the provided input classes
+     */
+    public static LoginView create(
+            ViewManagerModel viewManagerModel,
+            LoginViewModel loginViewModel,
+            LoggedInViewModel loggedInViewModel,
+            LoginUserDataAccessInterface userDataAccessObject,
+            SignupViewModel signupViewModel) {
+
+        final LoginController loginController = createLoginUseCase(viewManagerModel, loginViewModel,
+                loggedInViewModel, userDataAccessObject, signupViewModel);
+        return new LoginView(loginViewModel, loginController);
+
+    }
+
+    private static LoginController createLoginUseCase(
+            ViewManagerModel viewManagerModel,
+            LoginViewModel loginViewModel,
+            LoggedInViewModel loggedInViewModel,
+            LoginUserDataAccessInterface userDataAccessObject,
+            SignupViewModel signupViewModel) {
+
+        final LoginOutputBoundary loginOutputBoundary = new LoginPresenter(viewManagerModel,
+                loggedInViewModel, loginViewModel, signupViewModel);
+        final LoginInputBoundary loginInteractor = new LoginInteractor(
+                userDataAccessObject, loginOutputBoundary);
+
+        return new LoginController(loginInteractor);
+    }
+}

src/main/java/app/MainChessApp.java

@@ -0,0 +1,21 @@
+package app;
+
+/**
+ * Main that activates login page.
+ */
+public class MainChessApp {
+
+    /**
+     * The main method for starting the program with an external database used to persist user data.
+     * @param args input to main
+     */
+    public static void main(String[] args) {
+
+        final UserAppBuilder userAppBuilder = new UserAppBuilder();
+        userAppBuilder.addViewModels()
+                .addViews()
+                .initializeState()
+                .addChessGame()
+                .build();
+    }
+}