jessieh/simple-shortener
jessieh/simple-shortener
1
Fork 0
mirror of https://gitlab.com/jessieh/simple-shortener.git synced 2025-04-19 19:31:46 +00:00
Code Releases Activity

Compare commits

base: jessieh:1.0.0
Branches Tags
jessieh:main
jessieh:assets
jessieh:1.0.0
..
compare: jessieh:main
Branches Tags
jessieh:main
jessieh:assets
jessieh:1.0.0

5 Commits
1.0.0 ... main

Author SHA1 Message Date
Jessie Hildebrandt
6e3d51ac32 Change glob to recursive glob in .gitattributes 2022-02-02 00:44:52 -05:00
Jessie Hildebrandt
e52e1472ee Mark libraries as vendored for Linguist 2022-02-02 00:40:43 -05:00
Jessie Hildebrandt
6eb82dd2cd Fix strange bug with GitLab asset links in README 2022-02-02 00:32:18 -05:00
Jessie Hildebrandt
d522eca250 Add table of contents to readme 2022-02-02 00:27:43 -05:00
Jessie Hildebrandt
7dd54835d0 Add TOTP issuer icons to readme 2022-02-02 00:27:34 -05:00
2 changed files with 21 additions and 0 deletions
Show Stats Expand all files Collapse all files

1
.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
src/static/control_panel/lib/** linguist-vendored

20
README.md
View File

@ -8,6 +8,14 @@ Created with [Fennel](https://fennel-lang.org), [Turbo](https://github.com/kerne
[![Build Status](https://gitlab.com/jessieh/simple-shortener/badges/main/pipeline.svg)](https://gitlab.com/jessieh/simple-shortener/-/pipelines) [![Build Status](https://gitlab.com/jessieh/simple-shortener/badges/main/pipeline.svg)](https://gitlab.com/jessieh/simple-shortener/-/pipelines)
## Table of Contents
- [Demo](#demo)
- [Deploying](#deploying)
- [Configuration](#configuration)
- [API](#documentation)
- [TOTP Issuer Icons](#totp-issuer-icons)
## Demo ## Demo
<img src="../../raw/assets/demo.png"> <img src="../../raw/assets/demo.png">
@ -141,3 +149,15 @@ The shortening service exposes a simple API at `/shorten/api` that you may consu
The API endpoints and response codes are documented in the docstrings of their respective [handler modules](src/handlers). The API endpoints and response codes are documented in the docstrings of their respective [handler modules](src/handlers).
<sup>1</sup> If you wish to replace the default control panel, you can provide your own by mounting it at `/simple-shortener/static/control_panel`. <sup>1</sup> If you wish to replace the default control panel, you can provide your own by mounting it at `/simple-shortener/static/control_panel`.
## TOTP Issuer Icons
Should your TOTP provider application of choice support them, the following issuer icons are available for use.
### SVG
<img src="../../raw/assets/simple-shortener.svg" width=75>&nbsp;<img src="../raw/assets/simple-shortener bg.var.svg" width=75>
### PNG
<img src="../../raw/assets/simple-shortener.png" width=75>&nbsp;<img src="../raw/assets/simple-shortener bg.var.png" width=75>