https://github.com/barata-ribeiro/sentinelofliberty

Remake of the Sentinel of Liberty project, with Java Spring Boot for backend.
https://github.com/barata-ribeiro/sentinelofliberty

authjs integration-testing java java-23 jpa-entities next-auth nextjs nextjs15 react19 spring-boot spring-boot-3 spring-data-jpa spring-security-jwt springboot tailwindcss typescript

Last synced: 2 months ago
JSON representation

Remake of the Sentinel of Liberty project, with Java Spring Boot for backend.

• Host: GitHub
• URL: https://github.com/barata-ribeiro/sentinelofliberty
• Owner: Barata-Ribeiro
• License: gpl-3.0
• Created: 2024-12-14T10:19:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-21T17:34:44.000Z (about 1 year ago)
• Last Synced: 2025-05-21T18:46:39.077Z (about 1 year ago)
• Topics: authjs, integration-testing, java, java-23, jpa-entities, next-auth, nextjs, nextjs15, react19, spring-boot, spring-boot-3, spring-data-jpa, spring-security-jwt, springboot, tailwindcss, typescript
• Language: TypeScript
• Homepage:
• Size: 2.38 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    



Sentinel of Liberty is a full‑stack application providing JWT‑based authentication, rich‑text editing, and real‑time communication via WebSockets. Built to be a place where users can suggest news from third-party news providers, and through this list, the interaction between the ecosystem starts. An admin can freely write an article about said proposed suggestions, offering their opinion/alternate view about it. The project can be fully customized to fit your needs.

## Animated Demo

![SentinelOfLiberty](client/public/screenshot.gif "Sentinel of Liberty Demo")

## 📚 Features

- JWT authentication & authorization (NextAuth on frontend, Spring Security on backend).

- Rich‑text editor with TipTap (images, links, alignment, history).

- Real‑time updates via WebSockets and STOMP for notifications.

- API documentation with Swagger/OpenAPI.

- Persistence with JPA/Hibernate (H2 for dev/test, PostgreSQL for production).

- Data validation with Bean Validation.

## 🚀 Built With

### Frontend

The frontend of MediManage is built using modern technologies to ensure a responsive and seamless user experience.

- **Next.js 15**: A React framework for server-rendered applications.

- **React 19 + TypeScript**: A JavaScript library for building user interfaces.

- **Tailwind CSS**: A utility-first CSS framework for rapid UI development.

- **NextAuth**: Authentication for Next.js applications.

- **TipTap**: A highly customizable rich text editor built on ProseMirror, offering an intuitive editing experience.

- **STOMP.js**: A lightweight JavaScript client for STOMP messaging over WebSockets, enabling real‑time communication.

### Backend

The backend leverages the power of Spring Boot to provide a scalable and secure foundation for the application.

- **Spring Boot 3.5 \+ Java 23**: Provides a modern, robust framework and leverages the latest Java features for 

  efficient application development.

- **Spring Security**: Implements customizable security measures for authentication and authorization.

- **Spring Data JPA \(Hibernate\)**: Simplifies database interactions by mapping Java objects to relational data using Hibernate as the JPA provider.

- **Hibernate Search (Elasticsearch backend)**: Full-text search capabilities integrated with Hibernate ORM, using Elasticsearch as the search engine.

- **WebSockets \& STOMP**: Enables real-time, bidirectional communication between the client and server using the STOMP protocol over WebSockets.

- **H2 \& PostgreSQL**: Uses H2 for in-memory test environments and PostgreSQL for dev/production-grade persistence.

- **Swagger\/OpenAPI \(springdoc\-openapi\)**: Automatically generates interactive API documentation, easing API consumption and testing.

- **ModelMapper, Lombok**: Reduces boilerplate with efficient object mappings and code generation through annotations.

## 🛠️ Project Setup

### Prerequisites & verification (Windows cmd.exe)

Before you start, verify the tools required to run the frontend and backend. The commands below are written for Windows `cmd.exe`. If you use PowerShell or a Unix shell, replace `\` with `/` and execute the appropriate wrapper (for example `./mvnw` on macOS/Linux).

Minimum recommended versions (project was developed with these):

- Java 23 (required to build/run the backend)

- Node.js 20+ (Next.js requires a modern Node)

- pnpm (used to install frontend deps)

- Docker & Docker Compose (or Docker Desktop)

- Git

Verification commands (run in `cmd.exe`) and expected results:

- Java (runtime and compiler):

  ```bat

  java -version

  javac -version

  ```

  Expected: shows Java 23 (or compatible JDK). If `java` or `javac` is not found, install a JDK (Adoptium/Temurin, 

  Oracle, or OpenJDK) and ensure JAVA_HOME is set.

- Maven wrapper (optional if you prefer system Maven):

  ```bat

  .\mvnw.cmd -v

  ```

  The project ships a Maven wrapper (`mvnw.cmd`) so you do not need Maven installed globally. Running the wrapper prints the Maven version used.

- Docker and Docker Compose (verify containers):

  ```bat

  docker --version

  docker compose version

  docker ps

  ```

  Expected: Docker running and `docker ps` lists active containers. On Windows, Docker Desktop with WSL2 is recommended.

- Node / npm / pnpm:

  ```bat

  node -v

  npm -v

  pnpm -v

  ```

  If `pnpm` is missing, install it with:

  ```bat

  npm install -g pnpm

  ```

- Git:

  ```bat

  git --version

  ```

Quick diagnostic (copy and paste into `cmd.exe` to run basic checks):

```bat

java -version

javac -version

.\mvnw.cmd -v

node -v

npm -v

pnpm -v || echo pnpm not found

docker --version

docker compose version

docker ps

git --version

```

Common troubleshooting tips

- Java errors: make sure JAVA_HOME points to a JDK installation and that `java`/`javac` are on PATH. On Windows you can set JAVA_HOME in System Properties → Environment Variables.

- mvnw permission or execution problems: use `mvnw.cmd` on Windows (`.\mvnw.cmd spring-boot:run`). On Unix/macOS use `./mvnw spring-boot:run`.

- Docker on Windows: install Docker Desktop and enable WSL2 backend. Ensure the Docker service is running and you have sufficient permissions.

- Port conflicts: default ports are 3000 (frontend), 8080 (backend), 5432 (Postgres), 9200 (ElasticSearch). If any 

  port is busy, stop the occupying service or change the port in the corresponding config.

- pnpm / Node problems: ensure Node and pnpm are compatible with the Next.js version used. If builds fail, try clearing pnpm cache (`pnpm store prune`) and reinstalling (`pnpm install`).

1. **Clone repository**

   ```shell

   git clone https://github.com/Barata-Ribeiro/SentinelOfLiberty.git

   cd SentinelOfLiberty

   ```

2. **Environment variables**

   - Frontend: copy `client/.env.example` to `client/.env.local` and fill in:

     ```dotenv

     NEXT_PUBLIC_AUTH_TOKEN_NAME="TOKEN_NAME"

     AUTH_SECRET=AUTO_GEN_AUTH_JS_KEY

     AUTH_URL="http://localhost:3000/api/auth"

     AUTH_TRUST_HOST="true"

     NEXT_PUBLIC_BASE_URL="http://localhost:3000"

     NEXT_PUBLIC_BACKEND_ORIGIN="http://localhost:8080"

     ```

   - Backend: choose profile and copy corresponding file to `src/main/resources/application.properties`. Or use IDE

     to set up current profile and run the application using the required variables from each application.properties

     files.

3. **Using Docker & Docker Compose**

   - **Build & run all services**

     ```shell

     docker compose -f compose.yaml up --build

     ```

     This command uses your `Dockerfile` multi‑stage build to produce a lean runtime image, then starts both the API and a PostgreSQL database via Compose citeturn0search0turn0search1.

   - **Access services**

     - Frontend: http://localhost:3000

     - API (Swagger UI): http://localhost:8080/api-docs

     - PostgreSQL: host `localhost:5432`, DB `sentinel-of-liberty_db`, user `postgres`, password `postgres`.

4. **Local development (without Docker)**

   - **Frontend**

     ```shell

     cd client

     npm install

     npm run dev

     ```

   - **Backend**

     ```shell

     cd server

     ./mvnw spring-boot:run

     ```

## 🗂️ Folder Structure

```

.

├── client

│   ├── node_modules

│   ├── public

│   ├── src

│   │   ├── @types

│   │   ├── actions

│   │   ├── app

│   │   ├── components

│   │   ├── helpers

│   │   ├── providers

│   │   ├── utils

│   │   ├── auth.ts

│   │   └── middleware.ts

│   ├── .env.local

│   ├── .gitignore

│   ├── .prettierignore

│   ├── .prettierrc

│   ├── eslint.config.mjs

│   ├── next.config.ts

│   ├── next-env.d.ts

│   ├── package.json

│   ├── package-lock.json

│   ├── postcss.config.mjs

│   ├── tailwind.config.ts

│   └── tsconfig.json

└── server

    ├── .mvn

    ├── src

    │   ├── main

    │   │   └── java/com/barataribeiro/sentinelofliberty

    │   │       ├── builders

    │   │       ├── config

    │   │       ├── controllers

    │   │       ├── dtos

    │   │       ├── exceptions

    │   │       ├── models

    │   │       ├── repositories

    │   │       ├── services

    │   │       ├── utils

    │   │       └── ServerApplication.java

    │   └── test

    │       └── java/com/barataribeiro/sentinelofliberty

    │           ├── config/security

    │           ├── controllers

    │           ├── utils

    │           └── utilsTests

    ├── target

    ├── .gitattributes

    ├── .gitignore

    ├── compose.yaml

    ├── Dockerfile

    ├── HELP.md

    ├── mvnw

    ├── mvnw.cmd

    ├── pom.xml

    └── sentinel-of-liberty.iml

```

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/Barata-Ribeiro/SentinelOfLiberty/issues) if you want to contribute.

## 📜 License

This project is free software available under the [GPLv3](LICENSE) license.