https://github.com/heaversm/showlinks

Podcast Prototypes
https://github.com/heaversm/showlinks

Last synced: 21 days ago
JSON representation

Podcast Prototypes

• Host: GitHub
• URL: https://github.com/heaversm/showlinks
• Owner: heaversm
• Created: 2023-07-13T16:02:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-05T21:46:36.000Z (over 1 year ago)
• Last Synced: 2024-12-16T01:39:04.911Z (25 days ago)
• Language: JavaScript
• Size: 5.31 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Showlinks

Gain insights on user interaction with your podcast show notes

## Run Locally

* Clone the project**

* Get the `.env` file from the project owner

* [Sign up for the mongo atlas free tier](https://www.mongodb.com/cloud/atlas)

  * Choose your region and click on the "Create a free cluster" button

  * Choose "Connect Your Application" from the "choose a connection method" modal

  * Copy your connection URL and paste it in the .env file's `MONGO_URI` variable

* Install dependencies*

```bash

  npm install

```

* Start the server

```bash

  npm run start

```

## API Reference

### Shorten URL

```http

  POST /api/short

```

| Field | Type   | Description  |

| :---- | :----- | :----------- |

| Body  | `json` | Original Url |

**Example:**

```http

POST http://localhost:3333/api/short

Content-Type: application/json

{

    "origUrl": "https://nemo.hashnode.dev/an-introduction-to-recursion-using-javascript-ckfgx2nrq001xols17h787f87"

}

```

### Get item

```http

  GET /:id

```

| Parameter | Type     | Description     |

| :-------- | :------- | :-------------- |

| `id`      | `string` | Unique URL Code |

**Example:**

```http

GET http://localhost:3333/SLiCKEXdn

```

### Generate User ID

  

  ```http

    GET /api/generateUserId

  ```

### Get Stats

  ```http

    GET /api/stats

  ```

Pass either a `userId`, `episodeId` or `shortUrl` in the body to get the stats for that particular item