mirror of
https://github.com/ArthurDanjou/artdanj-shortener.git
synced 2026-01-14 18:59:56 +01:00
Add readme and license
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright 2021 © Arthur Danjou
|
||||
|
||||
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.
|
||||
42
ReadMe.md
Normal file
42
ReadMe.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# ArtClick 🔗
|
||||
|
||||
This is my personal URL Shortener.
|
||||
|
||||
Hosted version: [**artclick.fr**](https://artclick.fr) *(Soon)*
|
||||
|
||||
## Features ✨
|
||||
|
||||
- Create an unique short code to redirect to a very long link.
|
||||
- Caching with Redis to do not duplicate visit counts and to save resources.
|
||||
- Authentication with AdonisJs to secure the entries.
|
||||
- Visit Counts to have a few stats
|
||||
|
||||
## Tech used ⚙
|
||||
|
||||
- AdonisJs (HTTP Server & Authentication)
|
||||
- Redis (Caching)
|
||||
- MariaDB (Database)
|
||||
- Kubernetes + Docker (Deployment) *(Soon)*
|
||||
|
||||
## Usage 📚
|
||||
|
||||
- Authentication
|
||||
- https://artclick.fr/auth/login ➡ Login
|
||||
- https://artclick.fr/auth/logout ➡ Logout
|
||||
- Options
|
||||
- https://artclick.fr/options/create ➡ Create a new shortened link
|
||||
- https://artclick.fr/options/update ➡ Update a shortened link
|
||||
- https://artclick.fr/options/delete ➡ Delete a shortened link
|
||||
- Links
|
||||
- https://artclick.fr/ ➡ Get all links with informations
|
||||
- https://artclick.fr/(code) ➡ Redirect to the shortened link's target
|
||||
- https://artclick.fr/(code)/count ➡ Get the shortened link's visit count
|
||||
|
||||
## Author 👤
|
||||
➡ Arthur Danjou : Developer
|
||||
- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
|
||||
- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
|
||||
|
||||
## License 📑
|
||||
Copyright © 2020 - [@ArthurDanj](https://arthurdanjou.fr) \
|
||||
This project is [MIT](https://github.com/ArthurDanjou/artclick/blob/master/LICENSE) Licensed.
|
||||
Reference in New Issue
Block a user