Linkedin

<img src = "./screenshot.png"/>

Running the project on your machine

Prerequisites

Node.js (version 22 or compatible), npm (version 10 or compatible), Java JDK (version 21), and Docker (version 24.0.7 or compatible).

Backend Setup

Navigate to the backend directory:

cd backend

Run the docker containers:

docker-compose up

Set up continuous build:

Mac/Linux:

./gradlew build -t -x test

Windows:

gradlew.bat build -t -x test

Configure environment variables for OAuth 2.0 and OIDC, aka the Continue with Google button. Skip if you do not want to test this feature:

Mac/Linux:

export OAUTH_GOOGLE_CLIENT_ID=your_google_client_id
export OAUTH_GOOGLE_CLIENT_SECRET=your_google_client_secret

Windows:

set OAUTH_GOOGLE_CLIENT_ID=your_google_client_id
set OAUTH_GOOGLE_CLIENT_SECRET=your_google_client_secret

Run the backend:

Mac/Linux:

./gradlew bootRun

Windows:

gradlew.bat bootRun

Frontend Setup

Navigate to the frontend directory:

cd frontend

Set up the necessary environment variables:

Mac/Linux:

cp .env.example .env

Windows:

copy .env.example .env

⚠️: make sure all variables are populated. Leave VITE_GOOGLE_OAUTH_CLIENT_ID as is if you do not want to test Oauth 2.0 and OIDC.

Install dependencies:

npm install

Run the frontend in development mode:

npm run dev

You can access the backend at http://localhost:8080, the frontend at http://localhost:5173, and the Mailhog SMTP server UI at http://localhost:8025.

The database hostname is 127.0.0.1, the port is 3306, and the root password is root.

Github Actions

To test the CI/CD workflows locally, you can use the act tool. First, ensure you have act installed. Then, create a file named event.json with the following content (to simulate modifications to both frontend and backend):

{
  "repository": {
    "default_branch": "main"
  },
  "push": {
    "base_ref": "refs/heads/main",
    "commits": [
      {
        "modified": ["frontend/some-file.js", "backend/some-file.java"]
      }
    ]
  }
}

Run the following command to simulate a push event:

act -e event.json