https://github.com/neumanf/mally

A collection of web services such as URL shorteners, pastebins, and more.
https://github.com/neumanf/mally

angular docker java spring springboot typescript

Last synced: 2 months ago
JSON representation

A collection of web services such as URL shorteners, pastebins, and more.

• Host: GitHub
• URL: https://github.com/neumanf/mally
• Owner: neumanf
• License: mit
• Created: 2023-01-13T11:27:30.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-31T16:36:34.000Z (over 1 year ago)
• Last Synced: 2024-12-31T17:27:20.767Z (over 1 year ago)
• Topics: angular, docker, java, spring, springboot, typescript
• Language: TypeScript
• Homepage: https://mally.neumanf.com
• Size: 27.2 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          



  

    

  



[Mally](https://mally.neumanf.com)  is a web application that provides a collection of web services, including a URL shortener and a Pastebin-like service for sharing text and code snippets. It uses Angular for the frontend and Spring Boot for a modular monolith in the backend, along with Keycloak managing authentication, RabbitMQ handling message queuing, and PostgreSQL for data storage. It also has automated testing with Cypress and a fully configured CI/CD pipeline with GitHub Actions.

## Key Features

-  URL Shortener with QR Code for easy copy and share

-  Pastebin supporting over 10 programming languages

-  Dashboard with statistics about your usage

-  Management page for viewing, creating, updating and deleting data

-  Authentication

## Folder structure

```lua

mally

|

├── apps     -- Main folder where the application code is located

|   ├── ui          -- Angular front-end application

|   └── api         -- Spring Boot back-end application

├── infra    -- Infraesctructure-related Docker files and configuration 

|    ├── keycloak   -- Keycloak themes and configuration

|    ├── nginx      -- Nginx configuration files and scripts

|    └── postgres   -- PostgreSQL scripts

└── scripts  -- Development scripts

```

## Architecture

```mermaid

---

title: Mally Architecture

---

flowchart LR

%% Styles

    classDef app fill:#f7e081,stroke:#333,stroke-width:1px

%% Entities

    UI[UI - Angular]

    POSTGRES[(PostgreSQL)]

    API[API - Springboot]

    RMQ[RabbitMQ]

    REDIS[(Redis)]

%% Flow

    UI -->|HTTP|BACKEND

    subgraph BACKEND [API]

        API <-->|AMQP|RMQ

        direction LR

        API --> POSTGRES

        API --> REDIS

    end

```

## License

Mally is licensed under the [MIT License](LICENSE).