https://github.com/dev-adnani/url-shortner-backend
URL-Shortner enables you to shorten long-url from important locations on Instagram, Facebook, YouTube, Twitter, Linked In, and the Internet
https://github.com/dev-adnani/url-shortner-backend
api-documentation api-server backend backend-api expressjs mongodb mongodb-express-nodejs node nodejs postgresql rest-api-documentation server typeorm typescript
Last synced: 4 months ago
JSON representation
URL-Shortner enables you to shorten long-url from important locations on Instagram, Facebook, YouTube, Twitter, Linked In, and the Internet
- Host: GitHub
- URL: https://github.com/dev-adnani/url-shortner-backend
- Owner: Dev-Adnani
- Created: 2021-12-15T21:18:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-16T15:15:04.000Z (over 3 years ago)
- Last Synced: 2025-01-21T15:16:01.493Z (5 months ago)
- Topics: api-documentation, api-server, backend, backend-api, expressjs, mongodb, mongodb-express-nodejs, node, nodejs, postgresql, rest-api-documentation, server, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Url Shortner
- URL-Shortner enables you to shorten long-url from important locations on Instagram, Facebook, YouTube, Twitter, Linked In, and the Internet.
- Just paste the long URL and click the shorten URL button. On the next screen, copy the shortened URL and submit it to the website.
- The shortened URL can be used for distribution, registration, notification, website, discussion, text and various fields.
## Tech Stack
**Client:** [Flutter](https://github.com/Dev-Adnani/Url-Shortner-App)
**Server:** Node, Express , TypeScript
**Database:** MongoDB
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`MONGODB_URL`
## Run Locally
Clone the project
```bash
git clone https://github.com/Dev-Adnani/Url-Shortner-Backend
```
Go to the project directory
```bash
cd Url-Shortner-Backend
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
## Demo
https://urlshortner.devadnani.com
## API Reference
#### Generate Short Url
```http
POST /random
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `destination` | `string` | **Required**. Long Url |
#### Generates a short url with custom name
```http
POST /custom
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `destination` | `string` | **Required**. Long Url |
| `customText` | `string` | **Required**. Short Code |
```http
GET /:shortId
```
Will Redirect Your To Url If It Exists
## Support / Feedback
If you have any feedback or need any Support, please reach out to us at [email protected]