Final Project Developing Open Source Based Server-Side Applications: "Community"

A web application project that was developed using Spring Boot framework, and supplies various RESTful API services to users, using various libraries such as Jackson, Spring HATEOAS, Swagger UI, Data REST.

Table of Contents

1. About The Project
2. Libraries Used During Development
3. Getting Started
4. Usage
5. License
6. Contributors
7. Contact

About The Project

This project was developed fully in Java language, using Spring Boot framework.
In this project we implemented a system that manages users and offers a wide variety of functionalities. The user is offered not only the basic CRUD functionality, but rather get data about users using complex queries and conditions.

Throughout the whole project, RESTful representations were also implemented using HATEOAS library, Async programming was also used in this project by using CompletableFuture class, and data was fetched from 3 different API resources and mapped into POJOs using both RestTemplate and ObjectMapper.

In this project, one can create, get, edit and delete users, cell phone companies and/or perform manipulations with the data stored in the database.

Also, you may find several subjects such as:

1. Java 11 Overview & Functional Programming.
   
2. Multithreading and Java Streams.
   
3. Concurrent Design Patterns and algorithms.
   
4. Web Servers and Java Socket Programming.
   
5. Spring Framework/Java EE overview: IoC and Dependency Injection.
   
6. Introduction to Spring Boot and Web API development, Custom Exceptions and Handlers.
   
7. Spring MVC: Beans, JPA, Hibernate, Lombok, openapi/Swagger and MVC Controllers.
   
8. Spring Boot and RESTful representations using HATEOAS library Async programming using CompletableFuture<V>.
   
9. RESTful API development and advanced HTTP response manipulation and Spring Data REST.
   
10. Advanced Hibernate relations and RESTful representations assemblers.
    
11. DAO/DTO using Jackson and JSON properties.
    
12. Spring @Service and async tasks.
    

(back to top)

Libraries Used During Development

1. Swagger UI – A library that allows us to visualize and interact with the APIs resources, expanding about each and every endpoint available.
2. commons-io - A library of utilities to assist with developing IO functionality. We used this library in order to fetch a random user from external API.
3. org.json – A library that contains JSON encoders/decoders implemented in Java, and allows us to convert JSON data to Java concrete data types, and much more..
4. Lombok – A library that helps us to prevent boilerplate code in projects by using its annotations.
5. jackson-databind – A library that offers the general-purpose data-binding functionality. In this project, we used Jackson ObjectMapper.
6. H2 database - A library that allows us to use the H2 database functionality.

(back to top)

Getting Started

Follow these simple steps:

1. Clone the repo

   git clone https://github.com/RamMichaeli17/Community.git

2. Run the program

   press shift+F10 or press the "Run WebappApplication" button

   

3. Import requests to Postman using this link:
   https://www.getpostman.com/collections/3ae56741681d12e2a393

4. You may enter to H2 DB UI using this link:
   http://localhost:8080/h2

5. You may enter to Swagger-UI using this link:
   http://localhost:8080/swagger-ui/index.html

(back to top)

Usage

Demo Video:

** Increasing the speed of the video is recommended.

For more examples, please refer to the Documentation

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contributors

We thank the following people who contributed to this project:

Ram Michaeli

Yaniv Levi

Tal Beno

Contact

Ram Michaeli - ram153486@gmail.com

Project Link: https://github.com/RamMichaeli17/Community

(back to top)