RESTFul API - ShortUrl

This is a OpenSource project to learn NodeJS, MongoDB and All ecosystem arround this tech... This project is host on heroku.

Challange VanHack

This project contains all the information to complete my challenge at: Vanhack Challenge

Need add URL validation!!!! on Client and Back!!

Check here

Short URL - ShortURL

Getting Started

yes, I'm using yarn :)

Install yarn:

yarn is a fast, reliable, and secure dependency management tool. You can now use yarn to install reason and manage its dependencies.

To install Yarn, it is best to consult the official documentation for your particular platform.

Installing:

git clone https://github.com/shpsyte/urlshortener
cd urlshortener
yarn cache clean
yarn
yarn dev

yarn dev using nodemon to rebuild on change js files.. :)

Configue Database

Create a .ENV file with:

NODE_ENV=development,
DATABASE_HOST= mongodb://localhost:27017/urlshortener

Change your connection string! I'm using Docker, so you need create a Docker to use MongoDB (Or if you preffer use MongoAtlas!)

Run MondoDb on Docker!

docker run --name mongonode -p 27017:27017 -d -t mongo

Run app on Docker!

After copy from Git, if you need run on Docker tun this comand on Directory of application

docker build -t urlshort/node-web-app .

Your image will now be listed by Docker, and this comand will tun the App

docker run -p 8080:8080 -d urlshort/node-web-app

Navite on: http://localhost:8080/

Built With

• nodejs - NodeJS
• expressjs - Fast, unopinionated, minimalist web framework for NodeJS
• mongoDb - MongoDB Atlas Deploy a fully managed cloud database in minutes
• Docker - Future proof your Windows apps and drive continuous innovation
• ES6 - VanilaJS - Pure Javascript

Ps. Use MondoDB to scale!!

To developer this simple APP, I use Scrum. hahaha Check board here: (Now, all task is DONE. )

https://trello.com/b/K0deONn3/urlshortener

How to use API

There is a four API to use

POST

https://appshorturl.herokuapp.com/short

Short the URL

GET

https://appshorturl.herokuapp.com/show/<hey_to_find>

Get URL from short Key

https://appshorturl.herokuapp.com/data/<hey_to_find>

Get Statists from short Key

https://appshorturl.herokuapp.com/navigate/<hey_to_find>

Navigate to origin URL and update statistcs

Details API

[POST]

1. https://appshorturl.herokuapp.com/short

   You need send json body:

{
  "completeUrl": "URL_TO_ENCODE"
}

The return will be:

{
  "qtUse": 0,
  "_id": "5c44d6121ed99171a756058e",
  "completeUrl": "http://www.vanhack.com/",
  "keyOfUrl": "50UnUbM",
  "createAt": "2019-01-20T20:12:02.849Z",
  "__v": 0
}

[GET]

2. https://appshorturl.herokuapp.com/show/keyToFind

The return will be A ORIGIN URL, QT Of Use

{
  "qtUse": 2,
  "_id": "5c44cd5497491f63f663cece",
  "completeUrl": "http://uol",
  "keyOfUrl": "GNCcpHw",
  "createAt": "2019-01-20T19:34:44.640Z",
  "__v": 0
}

[GET]

3. https://appshorturl.herokuapp.com/Data/keyToFind

The return will be a collection OF statistics that you can use

[
  {
    "_id": "5c44ca7230afc960afc77152",
    "keyOfUrl": "yHktMkL",
    "fromIp": "::ffff:127.0.0.1",
    "fromCity": "Curitiba",
    "createAt": "2019-01-20T19:22:26.419Z",
    "__v": 0
  },
  {
    "_id": "5c44ca7530afc960afc77153",
    "keyOfUrl": "yHktMkL",
    "fromIp": "::ffff:127.0.0.1",
    "fromCity": "Curitiba",
    "createAt": "2019-01-20T19:22:29.818Z",
    "__v": 0
  },
  {
    "_id": "5c44ca7630afc960afc77154",
    "keyOfUrl": "yHktMkL",
    "fromIp": "::ffff:127.0.0.1",
    "fromCity": "Curitiba",
    "createAt": "2019-01-20T19:22:30.426Z",
    "__v": 0
  },
  {
    "_id": "5c44caea59083d616aa9cbc3",
    "keyOfUrl": "yHktMkL",
    "fromIp": "::ffff:127.0.0.1",
    "fromCity": "localhost",
    "fromCountry": "Brazil",
    "createAt": "2019-01-20T19:24:26.747Z",
    "__v": 0
  }
]

[GET]

4. https://appshorturl.herokuapp.com/navigate/keyToFind

The return will be a redirect to URL and Update statistics

Learning More

For more information, contact me, out the joseluiz.net. It should answer any questions you have not covered by the versions documentation.

Send me message at: joseluiz@joseluiz.net

Built and maintained by José Luiz