/Collife-Repo

Repository of project Collife - Creator PushnPop

Primary LanguageJavaApache License 2.0Apache-2.0

Collife - A social network from students to students

Collife allows its user to join a unique community of students all over the country, share their thoughts and communicate with one another.

Compile the code

To compile the Java program, you should first install the folder PushnPop from our repository to your computer and also have Maven installed on your device. Then being in the specific path(../PushnPop/) run the following command at terminal:

mvn clean compile assembly:single

Run the program

The app is compatible with the latest version of Java 19. In order to run the program, you should first move the executable jar file named Collife-0.0.1-SNAPSHOT-jar-with-dependencies.jar from PushnPop/target to the PushnPop directory. Also, move the .png file collife_logo.png on PushnPop folder , so it is at the same path as src. Then, run this command at any terminal:

java -cp Collife-0.0.1-SNAPSHOT-jar-with-dependencies.jar PushnPop.MainFinal

You have successfully runned our app via the main class MainFinal. For every next time you want to run it, you can do it either with the last command at terminal or by just double-clicking the executable jar file Collife-0.0.1-SNAPSHOT-jar-with-dependencies.jar (located at ../PushnPop/)

Contents of repository

This repository includes this README file, the .png file that contains the logo of our product and a file named PushnPop that represents the latest version of our code, the database file cc_db.db, the pom.xml file that we created through maven and a .md file standing as the licence for our app.

Data structures

In order to store the data that our app uses to run, we created a database file (cc_db.db) using SQLite. The database contains of two tables (Users, Messages) that represent the basic entities of our project.

Instructions of use

When oppening the app the users are met with a window that allows them to Signup and then Login to the app using their own credentials. Once logged in, one can select the category of the groupchat they want to join between the options: GENERAL, VOLUNTEER, NIGHTLIFE, TRAVEL, FOOD, UNIVERSITY. Then, one can view the posts - messages of previous users, add their own message or declare that they like a message from another user. Every user can also interact with the manu bar on the top of the app. In order to logout one can select the option exit on the top left corner of the window.

UML diagram

Below, we cite the UML diagram that describes the class structure of our project.

Model!ClassDiagram1_1