that-ambuj / url-shortener

A Basic URL shortener.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

URL Shortener (Vite + Koa.js)

I made this as my hobby project while learning Vue, Koa.js and sql databases. Feel free use it!

Getting Started

Clone this repo

git clone https://github.com/that-ambuj/url-shortener
cd url-shortener
yarn

Using in dev environment

yarn dev

The frontend will on visible http://localhost:5713 in your browser and backend will be on http://localhost:3000/api.

Using the production build

yarn build:start

The backend will serve static build files on https://localhost:3000, and the api on /api endpoint.

Tech Stack used :

  • Vue - Vue is a frontend framework I really became a fan of. I love it's typescript support and combination of speed with Vite.js.
  • Koa.js - Koa is a minimal backend framework which is way faster than express and has concise syntax.
  • Prisma ORM - Prisma a typesafe ORM mainly for SQL databases and I really like it typesafety when working with sql databases.
  • Sqlite3 - I'm using sqlite3 file-based sql database suitable for small to mid size projects. Using postgresql in a hobby project would have been overkill.
  • Yarn and Yarn workspaces - A package manager and project manager that helped me put both the frontend and the backend in a monorepo for easy developement.

About

A Basic URL shortener.


Languages

Language:SCSS 34.5%Language:Vue 34.0%Language:TypeScript 27.9%Language:HTML 3.6%