mirror of
https://github.com/ArthurDanjou/artdanj-shortener.git
synced 2026-01-14 15:54:08 +01:00
Update README.md
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Linky 🔗
|
||||
<p align="center">
|
||||
URL Shortener for Developers 💻
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/@linkyjs/core" target="__blank"><img src="https://img.shields.io/npm/v/@linkyjs/core?color=2B90B6&label=" alt="NPM version"></a>
|
||||
<a href="https://www.npmjs.com/package/@linkyjs/core" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@linkyjs/core?color=349dbe&label="></a>
|
||||
<a href="https://linkyjs.dev/" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=docs&color=45b8cd" alt="Docs"></a>
|
||||
<br>
|
||||
<a href="https://github.com/linkyjs/core" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/linkyjs/core?style=social"></a>
|
||||
</p>
|
||||
|
||||
## Features ✨
|
||||
|
||||
- ⛓ Create an unique short code to redirect to a very long link.
|
||||
- 🎭 Authentication with AdonisJs to secure the entries.
|
||||
- 📊 Visit Counts to have a few stats
|
||||
- 🎇 Automated Cli to save time
|
||||
|
||||
## Tech used ⚙
|
||||
|
||||
- AdonisJs (HTTP Server & Authentication)
|
||||
- TypeScript (Type Javascript)
|
||||
- MariaDB (Database)
|
||||
- Docker (Deployment)
|
||||
|
||||
## Informations ❕
|
||||
|
||||
📚 Documentations : **[English](https://linkyjs.dev)** | **[Français](https://fr.linkyjs.dev)**
|
||||
|
||||
🎤 Discord : Join my [Discord's server](https://discord.gg/zxHTbSs)
|
||||
|
||||
## Author 👤
|
||||
➡ Arthur Danjou : Developer
|
||||
- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
|
||||
- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
|
||||
|
||||
## License 📑
|
||||
Copyright © 2021 - [@ArthurDanj](https://arthurdanjou.fr) \
|
||||
This project is [MIT](https://github.com/linkyjs/core/blob/master/LICENSE) Licensed.
|
||||
41
ReadMe.md
41
ReadMe.md
@@ -1,41 +0,0 @@
|
||||
# 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.
|
||||
15
package.json
15
package.json
@@ -1,7 +1,18 @@
|
||||
{
|
||||
"name": "artclick",
|
||||
"name": "@linkyjs/core",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"description": "URL Shortener for Developers 💻",
|
||||
"main": "start/kernel.ts",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/linkyjs/core.git"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/linkyjs/core/issues"
|
||||
},
|
||||
"homepage": "https://github.com/linkyjs/core#readme",
|
||||
"scripts": {
|
||||
"build": "node ace build --production",
|
||||
"start": "node server.js",
|
||||
|
||||
Reference in New Issue
Block a user