https://github.com/urls/url-shortener

A modern, minimalist, and lightweight URL shortener.
https://github.com/urls/url-shortener

docker hactoberfest java mongodb spring-boot springdoc-openapi

Last synced: 3 months ago
JSON representation

A modern, minimalist, and lightweight URL shortener.

• Host: GitHub
• URL: https://github.com/urls/url-shortener
• Owner: urls
• License: mit
• Created: 2021-03-31T13:54:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-15T22:16:36.000Z (about 3 years ago)
• Last Synced: 2024-07-21T04:48:29.747Z (4 months ago)
• Topics: docker, hactoberfest, java, mongodb, spring-boot, springdoc-openapi
• Language: Java
• Homepage: http://urls.codes
• Size: 2.71 MB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# URL Shortner

[![URL Shortener Docker CD](https://github.com/urls/url-shortner/actions/workflows/ci-workflow.yml/badge.svg?branch=master)](https://github.com/urls/url-shortner/actions/workflows/ci-workflow.yml)

A modern, minimalist, and lightweight URL shortener application.

---

## Setup

### For devlopment:

1. Start the mongo container for database using docker:

    ```

    docker run --name mongo -p 27017:27017 -v $(pwd)/.local/data:/data/db mongo:latest

    ```

2. Start the `url-shortener-backend`:

    ```

    cd url-shortener-backend

    ./gradlew bootRun

    ```

> Note: You can also run the backend using any IDE.

### Alternatively, run application using docker-compose:

```

docker-compose up --build

```

---

## Issues

You can report the bugs at the [issue tracker](https://github.com/urls/url-shortener/issues)

**OR**

You can [tweet me](https://twitter.com/iamarpandey) if you can't get it to work. In fact, you should tweet me anyway.

---

## License

Built with ♥ by awesome [people](https://github.com/urls/url-shortener/graphs/contributors) under [MIT License](LICENSE)