README.md

DEI Academic Management System - AcaMS

Dependencies

• Require download
  • Java 21
  • Maven
  • Node 14+ (Node Version Manager recommended)
  • Docker
• No download required
  • Spring-boot
  • Vue.js

Run Locally

Clone the project

git clone git@gitlab.rnl.tecnico.ulisboa.pt:<REPO>

Go to the project directory

cd src/

Database

To run the database with Docker (recommended), run the following command:

docker compose up

Alternatively, you can create services that will be run in the background:

docker compose up -d

To stop the database, run the following command:

docker compose down

Backend

Create a copy of the application-local.properties file.

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

If you're running your database using Docker, the datasource variables should match the ones in Docker-compose.yml.

To build and run the backend, execute the following commands:

cd ./backend
mvn clean spring-boot:run

Frontend

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

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

Now, you need to install the dependencies:

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 (if you're using the provided Docker Compose file, PORT should be 7654, USER should be postgres and DB_NAME should be deidb):

psql -h localhost -p <PORT> -U <USER> <DB_NAME>