Merge pull request #3 from Kovah/go-rewrite

Rewrite in Go

Author: Kovah

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test with Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.14
+
+      - name: Install required packages
+        run: go mod download
+
+      - name: Link main repo as package
+        run: |
+          mkdir -p /home/runner/go/src/github.com/Kovah
+          ln -s /home/runner/work/DevLorem/DevLorem /home/runner/go/src/github.com/Kovah/DevLorem
+
+      - name: Build and test with Go
+        run: go test -run ''

.gitignore

@@ -0,0 +1,4 @@
+/dist
+/node_modules
+rice-box.go
+DevLorem

.goreleaser.yml

@@ -0,0 +1,56 @@
+project_name: devlorem
+
+before:
+  hooks:
+    - go mod download
+    - go get github.com/GeertJohan/go.rice
+    - rice -v embed-go
+
+builds:
+-
+  id: devlorem
+  binary: devlorem
+  env:
+    - CGO_ENABLED=0
+  goos:
+    - darwin
+    - linux
+    - windows
+    - freebsd
+    - netbsd
+    - openbsd
+    - dragonfly
+  goarch:
+    - amd64
+    - 386
+    - arm
+    - arm64
+  goarm:
+    - 7
+
+archives:
+-
+  name_template: "{{.ProjectName}}_{{.Version}}_{{.Os}}-{{.Arch}}"
+  replacements:
+    darwin: Darwin
+    linux: Linux
+    windows: Windows
+    386: i386
+    amd64: x86_64
+  files:
+    - README.md
+    - LICENSE.md
+
+checksum:
+  name_template: checksums.txt
+
+snapshot:
+  name_template: "{{.Tag}}"
+
+dockers:
+  - image_templates:
+      - "kovah/devlorem:latest"
+      - "kovah/devlorem:{{.Version}}"
+
+changelog:
+  sort: asc

Dockerfile

@@ -0,0 +1,3 @@
+FROM alpine:latest
+COPY devlorem /
+ENTRYPOINT ["/devlorem"]

README.md

@@ -1,37 +1,180 @@
-# DevLorem
+<h1 align="center">DevLorem</h1>
 
-Show paragraphs of real text ready to copy and paste. No more "Lorem ipsum dolor", get some lines from President Obama, 
-Jim Carrey or Morgan Freeman.
+<p align="center"><b>Real quotes ready to copy and paste. No more "Lorem ipsum dolor".</b><br>Get some quotes from President Obama, 
+Samuel L Jackson, Daisy Ridley or Morgan Freeman!</p>
 
-![Preview Screenshot](/preview.png)
+<p>&nbsp;</p>
 
-## Get Quotes via API
+<img src="/preview.png" alt="DevLorem Preview">
+
+<p>&nbsp;</p>
+
+
+## About DevLorem
+
+DevLorem is a small tool that generates Lorem Ipsum paragraphs from movie quotes, based on the different actors.  
+It can be used as a command line tool, or can be run as a website that offers both a user interface to generate the
+paragraphs and an API.
+
+
+---
+
+
+## Download DevLorem
+
+The latest version of the tool can be found on the [releases page](https://github.com/Kovah/DevLorem/releases).
+Please download the archive file of the latest release suitable for your operating system. Unpack the zip and make the
+binary executable.  
+Alternatively, you can use the Docker image. Details about the usage can be found further down.
+
+
+## The command line tool
+
+The command line tool can be used to quickly generate paragraphs within your terminal or in scripts. It is available
+as the `generate` command and has some optional parameters.
+
+```
+devlorem generate
+```
+
+Usage:  
+  devlorem generate [flags]
+
+Flags:  
+  -f, --format string        Format of the returned paragraphs, either json or text (default json)  
+  -h, --help                 help for generate  
+  -n, --number int           Number of paragraphs returned (default 5)  
+  -p, --paragraphs           Show paragraph tags (<p> and </p>) in the generated paragraphs
+
+
+#### Examples
+
+* `devlorem generate` would get you 5 quotes in JSON without `<p>` tags
+* `devlorem generate -n 15 -p` would get you 15 quotes in JSON including the `<p>` tags
+* `devlorem generate -n 30 -p -f text` would get you 30 quotes as plain text including the `<p>` tags
+* `devlorem generate -n 60 -f text` would get you 60 quotes as plain text without `<p>` tags
+
+
+---
+
+
+## The website (user interface + API)
+
+The DevLorem executable ships with a built-in web server including all static assets. You can start the web server by
+using the `serve` command. By default, the started web server listens to port 80 on your host.
+
+```
+$ devlorem serve
+Starting HTTP server for DevLorem...
+```
+
+You can now open DevLorem in your browser under `http://localhost`.
+
+If you want to use another port, you can use the optional bind flag. To change the port, specify the port including
+preceding colon. In the following example we tell DevLorem to use the port 8090:
+
+```
+devlorem serve -b :8090
+```
+
+
+### Usage of the website API
+
+Once the web server is started, the DevLorem API is available too. In the following examples I assume that you have set
+up DevLorem behind a proxy with the domain `your-domain.com` and HTTPS configured.
 
 Required URL structure:
-`your-domain.com/api/[int][/p][/json]`
+`https://your-domain.com/api/[int]`
+
+* The results will be returns as Json by default.
+* The maximum allowed amount of quotes is `99`.
+* Append `paragraphs=true` as a query parameter to show paragraph tags in the output.
+* Append `format=text` as a query parameter to get plain text output.
 
-* [int] = optional, number of paragraphs you want
-* [/p] = optional, select if the `<p>` tags should be included
-* [/json] = optional, output the data in JSON format
 
 #### Examples
 
-* `your-domain.com/api/15/p/json` would get you 15 paragraphs in JSON including the `<p>` tags
-* `your-domain.com/api/5/json` would get you 5 paragraphs in JSON without `<p>` tags
-* `your-domain.com/api/100/p` would get you 100 paragraphs as plain text including the `<p>` tags
-* `your-domain.com/api/100` would get you 100 paragraphs as plain text without `<p>` tags
+* `https://your-domain.com/api/5` would get you 5 quotes in JSON without `<p>` tags
+* `https://your-domain.com/api/15?paragraphs=true` would get you 15 quotes in JSON including the `<p>` tags
+* `https://your-domain.com/api/30?paragraphs=true&format=text` would get you 30 quotes as plain text including the `<p>` tags
+* `https://your-domain.com/api/60?format=text` would get you 60 quotes as plain text without `<p>` tags
+
+
+---
+
+
+## The DevLorem Docker image
+
+DevLorem is also available as a [Docker image](https://hub.docker.com/r/kovah/devlorem). It is built using Alpine
+Linux and is less than 10 MB large.
+
+To use the command line tool, run the Docker image with the `generate` command. More details about the tool can be
+found in the command line documentation above.
+
+```
+docker run --rm kovah/devlorem generate
+```
+
+To use the website, you have to additionally forward a port. Please notice that DevLorem does not support HTTPS
+connections, so you probably need a proxy in front of it.  
+You can start the web server by using the `serve` command. More details about the command can be found in the website 
+documentation above.
+
+```
+docker run --rm -p 80:80 kovah/devlorem serve
+```
+
 
 ---
 
-### Contribution
+
+## Contribution
 
 Want to contribute more source texts? Please create a pull request for the new file that should follow the exact same 
 styling like the ones that are already available:
 
-* Name the file by the person or thing you want to reference.
-* The text file should not contain special characters but can contain spaces.
-* Place all paragraphs into `<p></p>` tags.
+* Filename must contain the name (lowercase, spaces replaced with dashes).
+* The JSON strcuture must match the existing files.
+* Do not use any <p> tags in the quotes.
+
 
 ---
 
+
+## Development and Compilation
+
+### Development
+
+You need the following packages on your machine to be able to work on DevLorem and compile the binary:
+
+* github.com/spf13/cobra
+* github.com/gorilla/mux
+* github.com/GeertJohan/go.rice
+* github.com/GeertJohan/go.rice/rice
+
+This can be done by running `go mod download` in the current project directory.
+
+To test the package, compile it and then run the resulting executable. I recommend using [Goland]()
+for local development. 
+
+
+### Compilation
+
+To compile the binary and run it locally in the same folder, run the following command:
+
+```
+go build
+```
+
+To generate a single binary without any dependencies, you have to generate the needed content file for that:
+```
+rice embed-go
+# then run the build command
+go build
+```
+
+
+---
+
+
 DevLorem is a project by [Kovah](https://kovah.de) | [Contributors](https://github.com/Kovah/DevLorem/graphs/contributors)

api.php

@@ -0,0 +1 @@
+styles.css