mbos2 / url-shortener

Simple, Selfhosted, URLShortener service
MIT License
8 stars 3 forks source link
hacktoberfest hacktoberfest2023

URL Shortener

This is URL Shortener application ran by Appwrite cloud function., on Appwrite platform.
This project is part of Appwrites Lightning Hackathon.

Currently working demo: On this link

About

This project is a simple URL Shortener service.
It contains a form with URL and Alias inputs.

In URL input you add your URL you want shorten.
In Alias input you write something with what will you recognize what Short URL represents. It is only arbitrary.

It contains a button that can fetch your Short URLs from a database into the table on the same page.

Here is a project preview: Project Preview

Services

This project contains services:


Project Setup

Manual Setup

PROJECT-API-KEY is your api key from a project.
DOMAIN is your custom domain you want your function to run on. If you do not have custom domain registered and set, set your appwrite-gived domain for that function.
For example:

DOMAIN=624fbdf32f3aa04c42.appwrite.global
PROJECT_API_KEY=YOU API KEYWITH ALL PERMISSIONS

Development

This project is developed with:

Refer to Package JSON file

How to start with development

NOTE: Make code adjustments only inside dev folder. Code inside dev folder will be built into src folder.

How to deploy

How to use

Routes

Refer to the template to see how it is used in the simple frontend.