README.md

DEI Candidate Management System - CMS

The DEI Candidade Management System (CMS) is a platform that aims to facilitate the management of information regarding studentship candidacies and was developed as a pratical exercise within the scope of my candidacy to one of such studentship.

The platform has been developed with a Java backend using Spring-boot, and a frontend in Vue.js making much use of Vuetify components.

Requirements

• Java 21
• Maven
• Node 14+ (Node Version Manager recommended)
• Docker

Local Deployment

Clone the project

git clone [email protected]:SrGesus/candidatura-dei-2024.git

Go to the project source directory

cd candidatura-dei-2024/src

PostgreSQL

To run the database with Docker Compose, run the following command:

docker compose up

Alternatively without Compose:

docker run -d \
  --name postgres \
  -p 7654:5432 \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_DB=dmsdb \
  postgres:14-alpine

Backend

Create a copy of the application.properties file.

cp ./backend/src/main/resources/application.properties.example ./backend/src/main/resources/application.properties

Use Maven to run the backend:

cd ./backend
mvn clean spring-boot:run

Frontend

Now, you need to install the dependencies:

Create a copy of the example.env file named .env.

cp ./frontend/example.env ./frontend/.env

cd ./frontend
npm i

To run the frontend, run the following command:

npm run dev

Access the Database

In order to access the database, you can use the following command:

# psql postgres://USER:PASSWORD@HOSTNAME:PORT/DB
psql postgres://postgres:postgres@localhost:7654/dmsdb