Git Product home page Git Product logo

realworld-springboot's Introduction

RealWorld Example App

Spring Boot 3, Java 21 codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Spring Boot including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Spring Boot community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

How it works

The application uses Spring Boot 3 and Java 21 for all its architecture.

What Can it Do?

Here's the functionalities of the API:

  • User Authentication via JWT: It lets users sign in securely using JSON Web Tokens (JWT).
  • Users: Provides operations to create, read, and update user profiles.
  • Articles: Enables users to create, read, and delete articles.
  • Comments: Enables users to create, read, and delete comments on articles.
  • Article Listings: Offers paginated lists of articles with offset and limit params.
  • Article Favoriting: Allows users to mark articles as favorites.
  • User Following: Enables users to follow and unfollow other users profiles.
  • Article Feed: Offers a feed endpoint to see articles from followed users.

What's Under the Hood?

Here's the technologies used for the implementation:

  • Spring Data JPA for efficient data management.
  • Spring Security with JWT tokens for authentication.
  • JUnit5 and Mockito for testing.
  • MySql for the database.
  • Flyway for the database migrations.
  • modelmapper for the DTOs.
  • spring-arg-resolver, for dynamic param filtering.

How do i run it?

Here's the steps you need to make the project run:

You'll need docker installed.

  • Clone this repo.
  • Run docker-compose up.

That's it :)

realworld-springboot's People

Contributors

alonski avatar ericsimons avatar esakkiraj avatar gabrielgua avatar geromegrignon avatar optikfluffel avatar segmentationfaulter avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

antonarhipov

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.