Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m7moudgadallah/softlink
is a simple and efficient URL shortener designed to streamline the process of creating and sharing shortened URLs.
https://github.com/m7moudgadallah/softlink
expressjs functional-testing integration-testing jest mongodb mongoose nodejs postman rest-api unit-testing
Last synced: about 1 month ago
JSON representation
is a simple and efficient URL shortener designed to streamline the process of creating and sharing shortened URLs.
- Host: GitHub
- URL: https://github.com/m7moudgadallah/softlink
- Owner: m7moudGadallah
- License: mit
- Created: 2023-12-14T13:33:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-14T14:01:18.000Z (about 1 year ago)
- Last Synced: 2024-11-08T13:41:21.867Z (3 months ago)
- Topics: expressjs, functional-testing, integration-testing, jest, mongodb, mongoose, nodejs, postman, rest-api, unit-testing
- Language: JavaScript
- Homepage: https://documenter.getpostman.com/view/27682136/2s9Ykkf2yb
- Size: 151 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SoftLink
## Overview
Soft-Link is a simple and efficient URL shortener designed to streamline the process of creating and sharing shortened URLs. Users can submit their long URLs to the system, receiving a shortened version in return. When others click on the shortened URL, they are seamlessly redirected to the original link.
## Key Features
- **URL Shortening:** Quickly generate concise and shareable links.
- **Redirection:** Smoothly redirect users to the original URL when clicking on the shortened link.
## Tech Stack
- **Runtime:** Node.js
- **Language:** JavaScript/TypeScript
- **Framework:** Express.js
- **Database:** MongoDB with Mongoose
- **Testing:** Jest
- **Documentation and Manual Testing:** Postman
## Getting Started
### Prerequisites
**1. Install Dependencies:**
```bash
npm install
```
**2. Set Environment Variables:**
Rename the `.env.example` file to `.env` and fill in the required values.
### Running the Server
**1. Start the Server:**
```bash
npm start
```
**2. Run Tests:**
```bash
npm test
```
## API Documentation
Explore and test the API using **_[Postman](https://documenter.getpostman.com/view/27682136/2s9Ykkf2yb)_**. Refer to the provided Postman collection for details.
### Endpoints
**1. Create a Shortened URL:**
```http
POST {{URL}}/api/url/shorten
```
**2. Redirect to Original URL:**
```http
GET {{URL}}/api/url/:shortId
```
## Design
Refer to the `docs` directory for design details:
- [architecture-diagram](./docs/architecture-digram/arch-digram.png) for the project's architecture diagram.
- [erd](./docs/erd/erd.png) for the simple Entity-Relationship Diagram.
## License
This project is licensed under the [MIT License](./LICENSE).