Added License and WIP Readme
This commit is contained in:
parent
505c201654
commit
ed5ca366fe
20
LICENSE
Normal file
20
LICENSE
Normal file
@ -0,0 +1,20 @@
|
||||
Copyright (c) 2023 Joseph Ferano - joseph@ferano.io
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
16
README.org
Normal file
16
README.org
Normal file
@ -0,0 +1,16 @@
|
||||
# -*- org-src-preserve-indentation: t; olivetti-mode: t -*-
|
||||
#+TITLE: Zip My Link
|
||||
#+AUTHOR: Joseph Ferano
|
||||
|
||||
* About
|
||||
|
||||
This is a standard URL Shortening service built to practice web development.
|
||||
Currently it works at providing the most basic feature which is to give the user
|
||||
a shorter version of a URL they provide and then redirecting the user to the
|
||||
site when consuming the link.
|
||||
|
||||
** What I'm using
|
||||
- Python 3.11
|
||||
- FastAPI
|
||||
- CouchDB
|
||||
- ~podman~ and ~podman-compose~
|
@ -11,8 +11,9 @@
|
||||
- [X] Add DNS records
|
||||
- [X] Add to nginx.conf
|
||||
- [X] Generate certbot SSL cert
|
||||
* TODO Create a README.org
|
||||
* TODO Add MIT license
|
||||
* DONE Add MIT license
|
||||
* INPROGRESS Create a README.org
|
||||
|
||||
|
||||
* BACKLOG RTFM on how to create a container network
|
||||
* BACKLOG Gitea Actions
|
||||
|
Loading…
x
Reference in New Issue
Block a user