ShortURL - API (Backend)

Description

API image for a small Shorturl APP build with Vue.js, Node.js and MongoDB.

Build With

• Node.js v12.18.3
• Typescript v3.6.3
• Docker
• MongoDB

Features

• Create a short URL [POST] api/v1/urls
• Get all the short URLs [GET] api/v1/urls

Live Demo

TBA

Docker

This project is backend of a whole project. To run them all it's easy to use Docker.

Jump into that repository https://github.com/maelfosso/startup-files.git and follow the described steps to run them all as one.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Node.js v12 - Typescript v3.6 - MongoDB v3

Setup

Clone the repository

git clone https://github.com/maelfosso/shorturl-api.git 

Change the directory

cd shorturl-api

Start it

npm install
npm run prod

Run tests

npm run test

Authors

• Mael FOSSO : Github - LinkedIn