Xadrez

Chess game using Minimax AI, built for Software Engineering 2, a course from UFF Computer Science program.
Explore the docs »

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Building the project
3. Roadmap
4. Creators

About The Project

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps. This steps were done in Ubuntu 23.04.

Prerequisites

In order to setup the project locally, you will need to install the following prerequisites:

Archlinux Prerequisites

• Java 17

  sudo pacman -Syu
  sudo pacman -S jdk17-openjdk

• NodeJS and npm

  sudo pacman -S nodejs npm

• Docker

  sudo pacman -S docker docker-compose

• Reboot

Ubuntu Prerequisites

• Java 17

  sudo apt update && sudo apt upgrade
  sudo apt install openjdk-17-jre
  sudo apt install openjdk-17-jdk

• NodeJS and npm

  curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - &&\
  sudo apt-get install -y nodejs

• Docker

  sudo apt-get update
  sudo apt-get install ca-certificates curl gnupg
  
  sudo install -m 0755 -d /etc/apt/keyrings
  curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
  sudo chmod a+r /etc/apt/keyrings/docker.gpg
  
  echo \
  "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
  
  sudo apt-get update
  sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
  
  sudo groupadd docker
  sudo usermod -aG docker $USER
  newgrp docker

• Reboot

Building the project

In order to build and run the project, it's recommended that you use an IDE. We recommend to use JetBrains IntelliJ IDEA. The following steps will help you to setup the project using IntelliJ.

1. Clone the project using 'Get from VCS' option as soon as you open IntelliJ.

   git@github.com:Grupinix/Xadrez.git

2. Click on 'Run' and then 'Edit Configurations...'

3. Add 'npm' configuration, with package.json located in frontend/package.json and select dev for Scripts.

4. IF IT'S THE FIRST TIME BUILDING THE PROJECT: run the following code on IntelliJ terminal inside frontend folder:

   npm install

5. Now, run Docker compose setup, using the following code on IntelliJ terminal

   docker compose -f docker-compose-dev.yml up

6. Run the backend part using the Spring configuration that should be already configurated when you cloned the repository. In other words, run BackendApplication.java.

7. And finally, run the frontend part that you configurated for npm.

8. To access the application, just head to http://localhost:5173/.

(back to top)

Roadmap

• Themes
• Rooms
• Multiplayer
• Score system

(back to top)

Creators

• @Fernando Moreira
• @Felipe Salles
• @Henrique Porto
• @Paulo Felipe
• @Rodrigo Barroso
• @Yuri Nogueira

(back to top)