Official name!

This commit is contained in:
Przemek Dragańczuk 2020-04-18 22:53:01 +02:00
parent 7f275bf6af
commit 425b8a5f44
2 changed files with 8 additions and 9 deletions

View File

@ -25,13 +25,12 @@ unnecessary features, or they didn't have all the features I wanted.
# Planned features for 1.0 (in order of importance # Planned features for 1.0 (in order of importance
- Better deduplication - Better deduplication
- Code cleanup - Code cleanup
- An actual name
- Official Docker Hub image - Official Docker Hub image
# Usage # Usage
Clone this repository Clone this repository
``` ```
git clone https://github.com/draganczukp/url git clone https://github.com/draganczukp/simply-shorten
``` ```
## Building from source ## Building from source
Gradle 6.x.x and JDK 11 are required. Other versions are not tested Gradle 6.x.x and JDK 11 are required. Other versions are not tested
@ -62,7 +61,7 @@ java -jar build/libs/url.jar
### `docker run` method ### `docker run` method
1. Build the image 1. Build the image
``` ```
docker build . -t url:latest docker build . -t shorten:latest
``` ```
2. Run the image 2. Run the image
``` ```
@ -70,17 +69,17 @@ docker run -p 4567:4567
-d url:latest -d url:latest
-e username="username" -e username="username"
-e password="password" -e password="password"
-d url:latest -d shorten:latest
``` ```
2.a Make the database file available to host (optional) 2.a Make the database file available to host (optional)
``` ```
touch ./urls.csv touch ./urls.sqlite
docker run -p 4567:4567 \ docker run -p 4567:4567 \
-e username="username" \ -e username="username" \
-e password="password" \ -e password="password" \
-v ./urls.sqlite:/urls.csv \ -v ./urls.sqlite:/urls.sqlite \
-e db.url=/urls.csv \ -e db.url=/urls.sqlite \
-d url:latest -d shorten:latest
``` ```
## `docker-compose` ## `docker-compose`
There is a sample `docker-compose.yml` file in this repository configured for Traefik. You can use it There is a sample `docker-compose.yml` file in this repository configured for Traefik. You can use it

View File

@ -5,7 +5,7 @@
<meta name="viewport" <meta name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge"> <meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Url</title> <title>Simply Shorten</title>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.1/build/pure-min.css" <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.1/build/pure-min.css"
integrity="sha384-oAOxQR6DkCoMliIh8yFnu25d7Eq/PHS21PClpwjOTeU2jRSq11vu66rf90/cZr47" crossorigin="anonymous"> integrity="sha384-oAOxQR6DkCoMliIh8yFnu25d7Eq/PHS21PClpwjOTeU2jRSq11vu66rf90/cZr47" crossorigin="anonymous">