Tribe 🌐

Service Functionalities 🧠

• Developed a REST API service about social media world.
• Implemented JWT Authentication and Role-based Authorization with Login/Register services.
• Ability to create posts and make likes/comments.
• Ability to join tribes(groups) and bookmark posts.
• Developed follow, unfollow, block, unblock, search and feed services.
• Implemented view/clear search history service.
• Handled exceptions and input validations.
• Deployed to AWS EC2 using Docker and GitHub Actions CI/CD.

Folder Structure 📁

.
├── Dockerfile
├── README.md
├── docker-compose-dev.yaml
├── docker-compose.yaml
├── k8s
│   ├── deploy.sh
│   ├── ingress-nginx-controller.yaml
│   ├── postgres.yaml
│   └── tribe.yaml
├── mvnw
├── mvnw.cmd
├── pom.xml
├── setup-github-actions-runner.sh
├── src
│   └── main
│       ├── java
│       │   └── com
│       │       └── tribe
│       │           ├── TribeApplication.java
│       │           ├── config
│       │           │   ├── BeanConfig.java
│       │           │   └── SecurityConfig.java
│       │           ├── controller
│       │           │   ├── CommentController.java
│       │           │   ├── HistoryController.java
│       │           │   ├── LoginController.java
│       │           │   ├── PostBookmarkController.java
│       │           │   ├── PostController.java
│       │           │   ├── SignupController.java
│       │           │   ├── TokenController.java
│       │           │   ├── TribeController.java
│       │           │   ├── UserController.java
│       │           │   └── UserTribeController.java
│       │           ├── dto
│       │           │   ├── CommentRequestDto.java
│       │           │   ├── ContentDto.java
│       │           │   ├── ErrorDto.java
│       │           │   ├── HistoryRequestDto.java
│       │           │   ├── LoginRequestDto.java
│       │           │   ├── LoginResponseDto.java
│       │           │   ├── MessageDto.java
│       │           │   ├── PostBookmarkDto.java
│       │           │   ├── PostRequestDto.java
│       │           │   ├── SignupRequestDto.java
│       │           │   ├── TokenRequestDto.java
│       │           │   ├── TokenResponseDto.java
│       │           │   ├── TribeRequestDto.java
│       │           │   ├── UserBlockingDto.java
│       │           │   ├── UserDto.java
│       │           │   ├── UserFollowingDto.java
│       │           │   └── UserTribeDto.java
│       │           ├── entity
│       │           │   ├── Comment.java
│       │           │   ├── History.java
│       │           │   ├── Post.java
│       │           │   ├── PostBookmark.java
│       │           │   ├── Tribe.java
│       │           │   ├── User.java
│       │           │   ├── UserBlocking.java
│       │           │   ├── UserFollowing.java
│       │           │   └── UserTribe.java
│       │           ├── exception
│       │           │   ├── ApiError.java
│       │           │   ├── CustomAuthenticationExceptionEntryPoint.java
│       │           │   ├── CustomException.java
│       │           │   └── CustomExceptionHandler.java
│       │           ├── filter
│       │           │   └── JwtAuthenticationFilter.java
│       │           ├── repository
│       │           │   ├── CommentRepository.java
│       │           │   ├── HistoryRepository.java
│       │           │   ├── PostBookmarkRepository.java
│       │           │   ├── PostRepository.java
│       │           │   ├── TribeRepository.java
│       │           │   ├── UserBlockingRepository.java
│       │           │   ├── UserFollowingRepository.java
│       │           │   ├── UserRepository.java
│       │           │   └── UserTribeRepository.java
│       │           ├── response
│       │           │   └── MessageResponse.java
│       │           ├── service
│       │           │   ├── CommentService.java
│       │           │   ├── HistoryService.java
│       │           │   ├── LoginService.java
│       │           │   ├── PostBookmarkService.java
│       │           │   ├── PostService.java
│       │           │   ├── SignupService.java
│       │           │   ├── TokenService.java
│       │           │   ├── TribeService.java
│       │           │   ├── UserBlockingService.java
│       │           │   ├── UserFollowingService.java
│       │           │   ├── UserService.java
│       │           │   ├── UserTribeService.java
│       │           │   └── impl
│       │           │       ├── CommentServiceImpl.java
│       │           │       ├── HistoryServiceImpl.java
│       │           │       ├── LoginServiceImpl.java
│       │           │       ├── PostBookmarkServiceImpl.java
│       │           │       ├── PostServiceImpl.java
│       │           │       ├── SignupServiceImpl.java
│       │           │       ├── TokenServiceImpl.java
│       │           │       ├── TribeServiceImpl.java
│       │           │       ├── UserBlockingServiceImpl.java
│       │           │       ├── UserFollowingServiceImpl.java
│       │           │       ├── UserServiceImpl.java
│       │           │       └── UserTribeServiceImpl.java
│       │           ├── util
│       │           │   ├── AuthenticationUser.java
│       │           │   ├── CustomUser.java
│       │           │   ├── JwtUtil.java
│       │           │   ├── PostBookmarkId.java
│       │           │   ├── Roles.java
│       │           │   ├── UserBlockingId.java
│       │           │   ├── UserFollowingId.java
│       │           │   ├── UserTribeId.java
│       │           │   └── UsernameGenerator.java
│       │           └── validation
│       │               ├── RoleValidator.java
│       │               └── annotation
│       │                   └── ValidRole.java
│       └── resources
│           ├── application-prod.properties
│           └── application.properties

Usage 🛠️

• Kubernetes
  • Run deploy.sh file:

    cd ./k8s
    chmod +x ./deploy.sh
    sudo ./deploy.sh

• Docker
  • Run in development environment:

    docker-compose -f docker-compose-dev.yaml up -d --build
    # to stop --> docker-compose -f docker-compose-dev.yaml down

  • Run in production environment:

    docker-compose up -d --build
    # to stop --> docker-compose down

CI/CD 🚀 🔗

• CI:
  • Checkout the code.
  • Login to dockerhub.
  • Build the docker image.
  • Push the docker image to dockerhub.
• CD (on AWS EC2 Ubuntu machine as GitHub Actions Self-hosted Runner 🔗):
  • Stop & Remove existing containers.
  • Delete existing images.
  • Checkout the code.
  • Run the containers via docker-compose.yaml file.

Database Design 📝

Tech Stack ⚡

• Programming Language: Java 17
• Backend Framework: Spring Boot v3.1.2
• Database Engine: PostgreSQL
• Other Frameworks: Spring Security Data JPA, Hibernate
• API Documentation: Swagger via OpenApi 3.0
• Containerization and Orchestration: Docker 🔗 🔗, Kubernetes 🔗
• Cloud: AWS cloud
• CI/CD: GitHub Actions 🔗 🔗

Features to add in the future 💭

• Adding OAuth 2.0.

Contribution 🤝

If you're interested in contributing to this repository, please follow these guidelines:

• Fork the repository.
• Make your changes.
• Submit a Pull Request.