project: add url shortener (#134)

## Related Issue #114 ## Email id used to regsiter for VSoc'24 shiva02939@gmail.com ## Description *Project Added* (#114 ) Adds an URL shortener that convers long urls into redirects from the service. ## Type of PR - [ ] Bug fix - [ ] Feature enhancement - [ ] Documentation update - [ ] Security enhancement - [X] Other (specify): Project Submission check in issue by entering [X] in boxes ## Screenshots / Videos (if applicable) https://github.com/dhairyagothi/50_days_50_web_project/assets/70657005/63b97f6a-d387-41b1-8077-bc348a69afa9 [Attach any relevant screenshots or videos demonstrating the changes] ## Checklist - [X] I have performed a self-review of my code. - [X] I have read and followed the Contribution Guidelines. - [X] I have tested the changes thoroughly before submitting this pull request. - [X] I have provided relevant issue numbers, screenshots, and videos after making the changes. - [x] I have commented my code, particularly in hard-to-understand areas. - [X] I have followed the code style guidelines of this project. - [X] I have checked for any existing open issues that my pull request may address. - [X] I have ensured that my changes do not break any existing functionality. - [X] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. - [X] I have read the resources for guidance listed below. - [X] I have followed security best practices in my code changes.
dhairyagothi · Jun 21, 2024 · 9cb85f8 · 9cb85f8
2 parents fe6a1df + 6c2bde3
commit 9cb85f8
Show file tree

Hide file tree

Showing 10 changed files with 2,417 additions and 0 deletions.
diff --git a/public/index.html b/public/index.html
@@ -273,6 +273,11 @@
             <div class="project-name">TextToVoiceConverter</div>
             <a href="TextToVoiceConverter/index.html" class="demo-link">Demo</a>
         </div>
+        <div class="table">
+            <div class="day-number">Day 49</div>
+            <div class="project-name">Url Shortener</div>
+            <a href="https://github.com/dhairyagothi/50_days_50_web_project/tree/Main/public/url_shortener" class="demo-link">Demo</a>
+        </div>
     </div>
 
     <script>

diff --git a/public/url_shortener/.gitignore b/public/url_shortener/.gitignore
@@ -0,0 +1,2 @@
+output.css
+data.db
diff --git a/public/url_shortener/README.md b/public/url_shortener/README.md
@@ -0,0 +1,19 @@
+# url_shortener
+
+Shorten URLs into simple redirect codes.
+
+## setup
+
+* Install the required packages using the package manager of your choice (`npm`, `yarn`, `pnpm`, etc...)
+```
+yarn
+```
+* build the project and run it
+```sh
+yarn build
+node server.js
+```
+* (or) run directly
+```sh
+yarn dev
+```
diff --git a/public/url_shortener/index.html b/public/url_shortener/index.html
@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>URL Shortener</title>
+    <link rel="stylesheet" href="./output.css">
+    <script>
+        function sendurl() {
+            let input = document.getElementById("urlInput")
+            let output = document.getElementById("urlOutput")
+            if (!URL.canParse(input.value)) {
+                alert("invalid url!")
+                return;
+            }
+            let request = new XMLHttpRequest()
+            request.open("POST", `/new`,)
+            request.onload = () => {
+                console.log(request.response)
+                let url = `${window.location}${JSON.parse(request.response).urlPath}`
+                output.innerHTML = `<a href="${url}">${url}</a>`
+            }
+            request.setRequestHeader(
+                'Content-Type', 'application/json'
+            )
+            request.send(JSON.stringify({
+                url: input.value
+            }),)
+        }
+    </script>
+</head>
+
+<body class="bg-slate-900">
+
+    <div class="flex h-screen">
+        <div class="m-auto items-center">
+            <div class="font-sans font-bold text-pink-50 text-3xl text-center mb-5">URL Shortener</div>
+            <input id="urlInput" class="rounded px-4 py-2 outline-none bg-pink-50 w-[280px] md:w-[400px]"
+                placeholder="Enter the URL to shorten here">
+            <button class="md:ml-3 bg-green-500 hover:bg-green-600 p-2 rounded text-white" onclick="sendurl()">
+                <p class="hidden md:block">Generate</p>
+                <p class="block md:hidden"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16"
+                        fill="currentColor" class="bi bi-caret-right-fill" viewBox="0 0 16 16">
+                        <path
+                            d="m12.14 8.753-5.482 4.796c-.646.566-1.658.106-1.658-.753V3.204a1 1 0 0 1 1.659-.753l5.48 4.796a1 1 0 0 1 0 1.506z" />
+                    </svg></p>
+            </button>
+            <div class=" flex p-1 bg-green-100 rounded mt-2"><b>URL:&nbsp;</b>
+                <div id="urlOutput"></div>
+            </div>
+        </div>
+    </div>
+
+</body>
+
+</html>
diff --git a/public/url_shortener/input.css b/public/url_shortener/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
diff --git a/public/url_shortener/package.json b/public/url_shortener/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "url_shortener",
+  "version": "1.0.0",
+  "description": "A url shortener using express and sqlite3",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {"build": "tailwindcss -i input.css -o output.css; tsc", "dev": "tailwindcss -i input.css -o output.css; tsc; node server.js"},
+  "dependencies": {
+    "express": "^4.19.2",
+    "sqlite3": "^5.1.7"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.14.7",
+    "tailwindcss": "^3.4.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.2"
+  }
+}
diff --git a/public/url_shortener/server.ts b/public/url_shortener/server.ts
@@ -0,0 +1,44 @@
+import express, { Request } from "express"
+import sqlite from "sqlite3"
+let app = express()
+let db = new sqlite.Database("data.db")
+app.use(express.json())
+db.exec(
+    `CREATE TABLE IF NOT EXISTS urls ( short VARCHAR(10), pointedTo VARCHAR );`
+)
+function generateRandomString(length: number) {
+    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    let result = '';
+    for (let i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() * characters.length));
+    }
+    return result;
+}
+
+app.get("/", (req, res) => {
+    res.sendFile(__dirname + "/index.html")
+})
+app.get("/output.css", (_, res)=>{
+    res.sendFile(__dirname+"/output.css")
+})
+
+
+app.post("/new", (req: Request<{}, {}, {url: string}>, res) => {
+    let gen = generateRandomString(10)
+    db.prepare("INSERT INTO urls VALUES (?, ?)").run(gen, req.body.url).finalize()
+
+    return res.send({
+        urlPath: gen
+    })
+})
+
+app.get("/:url", (req, res)=>{
+    db.each(`SELECT * FROM urls WHERE short=?`, req.params.url, (err: any, row: {pointedTo: string})=>{
+        res.redirect( 301,row.pointedTo,)
+    })
+
+})
+
+app.listen(3000, () => {
+    console.log("server listening at 3000")
+})
diff --git a/public/url_shortener/tailwind.config.js b/public/url_shortener/tailwind.config.js
@@ -0,0 +1,9 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: ["index.html"],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+}
+
diff --git a/public/url_shortener/tsconfig.json b/public/url_shortener/tsconfig.json
@@ -0,0 +1,108 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}