https://github.com/tonyh0401/nodejs-url-shortener-api

A Simple Url Shortener API using NodeJS, ExpressJS and SQLite3
https://github.com/tonyh0401/nodejs-url-shortener-api

api-rest expressjs nodejs sqlite3

Last synced: 10 days ago
JSON representation

A Simple Url Shortener API using NodeJS, ExpressJS and SQLite3

• Host: GitHub
• URL: https://github.com/tonyh0401/nodejs-url-shortener-api
• Owner: TonyH0401
• Created: 2024-02-17T13:35:27.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-03-16T15:32:36.000Z (8 months ago)
• Last Synced: 2024-03-16T17:36:31.562Z (8 months ago)
• Topics: api-rest, expressjs, nodejs, sqlite3
• Language: JavaScript
• Homepage: https://nodejs-url-shortener-api.onrender.com
• Size: 56.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Simple URL Shortener API

## Description

Simple URL Shortener API shortens URL links into smaller links for easy access. The shortened links **expired after 30 minutes**. The results after each processes are returned in JSON format, so I highly advice using tools like Postman to perform requests. 

## Tech

- NodeJS

- ExpressJS

- SQLite

## Installation

This project requires [Node.js](https://nodejs.org/) v10+ to run. Please install the dependencies brefore starting the server.

```sh

cd nodejs-url-shortener-api

npm i

npm start

```

## Environment Variables:

```sh

BE_PORT=""

```

## Command

Create Shorten URL:

```sh

POST /api/v1/urls

{

    "originalUrl": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"

}

```

Access Shorten URL:

```sh

GET /api/v1/urls/access/<>

```

## Website

Simple URL Shortener API is deployed on [Render] and you can access the API by using this link "nodejs-url-shortener-api.onrender.com".

**Status**: offline

## License

MIT

**Free Software, Hell Yeah!**

[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)

   [Render]: 

   [git-repo-url]: 

   [john gruber]: 

   [df1]: 

   [markdown-it]: 

   [Ace Editor]: 

   [node.js]: 

   [Twitter Bootstrap]: 

   [jQuery]: 

   [@tjholowaychuk]: 

   [express]: 

   [AngularJS]: 

   [Gulp]: