Giter Club home page Giter Club logo

nestjs-url-shortener's Introduction

Description

A Nest based url shortener written in TypeScript and leveraging MongoDB for storage.

System Overview

alt text

Available Endpoints

  1. POST: http://localhost:3000/create-url

    Payload:

    {
    "longUrl": "https://www.linkedin.com/in/christophermilian/"
    }
    
  2. GET: http://localhost:3000/{generatedCode}

  • Must be entered in a browser for proper redirection

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Local MongoDB Setup

# Install MongoDB via Homebrew
brew tap mongodb/brew

# Update brew packages
brew update

# Install mongodb
brew install [email protected]

Before running mongosh, you need to create an admin user to secure the connection. Steps for creating an admin user can be found here, Authenticate with SCRAM

# run mongod authenticated
mongod --auth --port 27017 --dbpath /opt/homebrew/var/mongodb

# run mongosh with admin (please use unique user and password)
mongosh --port 27017  --authenticationDatabase "admin" -u "myUserAdmin" -p

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

MIT licensed

nestjs-url-shortener's People

Contributors

christophermilian avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.