Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluecap-se/minime.java

Link shortener app
https://github.com/bluecap-se/minime.java

aws docker java maven nginx postgres reactjs springboot terraform

Last synced: 9 days ago
JSON representation

Link shortener app

Host: GitHub
URL: https://github.com/bluecap-se/minime.java
Owner: bluecap-se
License: mit
Created: 2023-08-08T13:37:29.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2023-08-28T12:05:06.000Z (about 1 year ago)
Last Synced: 2024-04-15T06:58:53.944Z (7 months ago)
Topics: aws, docker, java, maven, nginx, postgres, reactjs, springboot, terraform
Language: HCL
Homepage:
Size: 421 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # MiniMe

[![Backend](https://github.com/bluecap-se/minime.java/actions/workflows/backend.yml/badge.svg)](https://github.com/bluecap-se/minime.java/actions/workflows/backend.yml)

[![Frontend](https://github.com/bluecap-se/minime.java/actions/workflows/frontend.yml/badge.svg)](https://github.com/bluecap-se/minime.java/actions/workflows/frontend.yml)

![Status](https://img.shields.io/badge/status-stable-brightgreen.svg)

![Coverage](https://img.shields.io/badge/coverage-88%25-green.svg)

![Java Version](https://img.shields.io/badge/java-20-blue.svg)

[![Docker pulls](https://img.shields.io/docker/pulls/bluecap/minime.java)](https://hub.docker.com/r/bluecap/minime.java)

![Platform](https://img.shields.io/badge/platform-win%20%7C%20lin%20%7C%20osx-lightgrey.svg)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bluecap-se/minime.java/blob/master/LICENSE)

The last link shortener you'll ever need.

This is a fork of the Minime project in Python: https://github.com/bluecap-se/minime

## Get started

### Run with Docker

Minime can run with [Docker](https://www.docker.com) compose, to set up follow these steps:

```

$ git clone [email protected]:bluecap-se/minime.java.git && cd "$_"

$ make up

$ open http://127.0.0.1:8080

```

## Deployment

Docker images are built and pushed to Docker Hub by Github Actions.

### AWS ECS

Minime can be deployed on AWS ECS using [Terraform](https://www.terraform.io).

```

$ make infra-init

```

Then apply the changes with:

```

$ make infra-apply

```

## Run tests

Run the tests in docker container:

```

$ make test

```

### Test coverage

```

$ make test-coverage

$ open target/site/jacoco/index.html

```

## TODO

- [ ] Add Terraform to Github Actions.

## License

Published under [MIT License](https://github.com/bluecap-se/minime.java/blob/master/LICENSE).