Cognition is - plain and simple - a flashcard application. If you've used Quizlet, Cognition should feel quite familiar.
The Java project is located inside the cognition
directory. Click here
to read the project description.
The documentation for each deliverable is located inside the docs
directory. Click here to read the deliverable documentation.
Developed by:
- Magnus Rødseth
- Julian Grande
- Thomas Hasvold
- Henrik Skog
- JavaFX (client application)
- Java
- Maven
- Spring Boot (web server application)
Make sure you have Maven installed and can successfully use mvn
in your terminal. Launching the application using Gitpod should automatically solve this issue for you. If you are on Mac or Linux, simply open the terminal and write brew install maven
if you do not have Maven installed locally already.
The cognition
project supports using make
as a wrapper for running mvn
commands. This is done to improve the quality of life for the current developers and "future" developer, i.e. the person grading this project.
# Navigate to the cognition directory.
cd cognition
# Install dependencies, start application server, and start client application.
# Alternatively, "make app" does the same.
make
# Install dependencies, and run tests for all modules.
make test
# Print the available targets.
make help
make test
and make
are all that is needed to run tests and the Cognition application.
Please see the Makefile
for more information on the targets we have made.
# Navigate to the cognition directory.
cd cognition
# Install dependencies and run tests in all modules.
mvn clean install
# Start Spring Boot server on port for application logic.
cd api && mvn spring-boot:run
# Run the client application.
cd ui && mvn javafx:run
# Stop Spring Boot server running on port for application logic
lsof -t -i:8080 | xargs kill -9
As seen in the commands above, the make
option is clearly quicker and more pleasant for the developer.
Click here for more information on packaging the application.