To setup the project, one needs to have all the prerequisites installed. Clone the repository, install the dependencies and build the project. This is described in more detail below.
Before setting up BoardMaster, ensure that your system meets the following requirements:
Ensure that git is installed on your machine. Download Git
Node.js 16 or higher (Download from Node.js website)
BoardMaster requires Node.js to be installed. The project is tested with Node.js 16 and Node.js 20, but it should work fine with any version 16 or higher.For the backend, one can use docker or install the prerequisites manually.
Need to have docker installed on your machine. Download Docker
- Java JDK 17 or higher - Java Development Kit is essential for compiling and running Java applications.
- Download and install it from Oracle's Java JDK Download Page or adopt an open-source JDK like AdoptOpenJDK.
- After installation, verify the installation by running
java -version
andjavac -version
in your command line or terminal.
Java JDK 17 or higher (Download from Oracle's website)
BoardMaster requires Java JDK to be installed. The project is tested with JDK 17, but it should work fine with any version 17 or higher.- Gradle 8 or higher - Gradle brings advanced build toolkit to manage dependencies and other aspects of the build process.
- You can download Gradle from the Gradle Download Page.
- Alternatively, if you are using a Gradle Wrapper script (gradlew or gradlew.bat), you do not need to manually install Gradle, as the wrapper script will handle the installation for you.
- To confirm that Gradle is properly installed, run
gradlew -v
in your command line or terminal which will display the installed Gradle version.
Gradle 8 or higher
Gradle is used as the build tool for BoardMaster. It automates the process of building, testing, and deploying the application.Follow these steps to set up BoardMaster on your local machine:
git clone https://github.com/SverreNystad/board-master.git
After cloning, move into the BoardMaster project directory:
cd board-master
Install node package manager
npm install
npm start
After starting the node package manager, the frontend should be available at http://localhost:3000/ and should pop up in your default browser.
Note: Remember that cmd
uses gradlew
and bash
uses ./gradlew
.
gradlew bootBuildImage --imageName=cogito/boardmaster
docker run -p 8080:8080 -t cogito/boardmaster
After starting the backend, the backend should be available at http://localhost:8080/
Inside the project directory backend
, use Gradle to build the project:
gradlew build
This command compiles the project and downloads all necessary dependencies.
To run the project, run the following command in the root directory of the project:
gradlew bootRun
No tests yet
To run all the tests, run the following command in the backend
directory of the project:
gradlew test
To generate a code coverage report, use the following Gradle command in backend
directory of the project:
gradlew test jacocoTestReport
To generate the documentation, use the following Gradle command in backend
directory of the project:
gradlew buildClassDiagram
This will create a class-diagram
in the docs
directory of the project. Open the backend.plantuml
file in Plant Uml editor to view the documentation.