Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ososuna/cliplink-rest
📎 ClipLink Rest API - URL Shortener
https://github.com/ososuna/cliplink-rest
clean-architecture express mongodb nodejs rest-api typescript url-shortener
Last synced: 3 days ago
JSON representation
📎 ClipLink Rest API - URL Shortener
- Host: GitHub
- URL: https://github.com/ososuna/cliplink-rest
- Owner: ososuna
- Created: 2024-11-24T20:29:29.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-12-28T17:38:55.000Z (11 days ago)
- Last Synced: 2024-12-28T18:25:07.010Z (11 days ago)
- Topics: clean-architecture, express, mongodb, nodejs, rest-api, typescript, url-shortener
- Language: TypeScript
- Homepage: https://cliplink.app
- Size: 880 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
![Unlicense License][license-shield]
[![LinkedIn][linkedin-shield]][linkedin-url]
ClipLink - URL Shortener
The ultimate URL shortener for seamless link management. Shorten, customize, and track your links with ease. Boost your branding and analytics with a fast, reliable, and user-friendly solution. Try ClipLink today!
Explore the site »
Table of Contents
## About The Project
ClipLink is a minimalistic, high-performance URL shortener designed with usability at its core. Whether you're managing a large number of links or just need a quick way to create short, shareable URLs, ClipLink makes it simple and efficient.
#### Key features:
* Minimalistic Design: Clean and intuitive interface ensures an effortless user experience.
* Third-party authentication: Google and Github authentication.
* Blazing Fast Performance: Optimized backend and frontend deliver instant results.
* Customizable Links: Personalize your short URLs to make them memorable.
* Scalable Architecture: Built to handle growing demands without compromising speed.
#### Why Choose ClipLink?
ClipLink was crafted with simplicity and performance in mind, making it the perfect tool for users who value ease of use and speed without unnecessary bloat.
### Built With
* [![Astro][Astro]][Astro-url]
* [![React][React.js]][React-url]
* [![shadcn][shadcn]][shadcn-url]
* [![TailwindCSS][TailwindCSS]][TailwindCSS-url]
* [![Vercel][Vercel]][Vercel-url]
* [![Render][Render]][Render-url]
* [![Express.js][Express.js]][Express-url]
* [![MongoDB][MongoDB]][MongoDB-url]
## Getting Started
Follow these steps to clone and set up the ClipLink URL Shortener on your local machine:
### Prerequisites
Ensure you have the following installed:
1. [Node.js](https://nodejs.org/) (version 16 or higher recommended)
2. [pnpm](https://pnpm.io/), [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) package manager
### Installation
1. Clone the repo
```sh
git clone https://github.com/ososuna/cliplink-rest.git
```
2. Install NPM packages
#### Using pnpm
```bash
pnpm install
```
#### Using npm
```bash
npm install
```
#### Using yarn
```bash
yarn
```
3. Create a .env file in the root of the project and enter your own environment variables
```.env
PORT=
MONGO_URL=
MONGO_DB_NAME=
JWT_SEED=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_CALLBACK_URL=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK_URL=
RESEND_API_KEY=
WEB_APP_URL=
```
4. Change git remote url to avoid accidental pushes to base project
```sh
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
```
5. Start docker-compose to set up a MongoDB instance in your local
```bash
docker-compose up
```
6. Start the Development server
#### Using pnpm
```bash
pnpm run dev
```
#### Using npm
```bash
npm run dev
```
#### Using yarn
```bash
yarn dev
```
7. Start the ClipLink UI following the next instructions: [https://github.com/ososuna/cliplink-ui?tab=readme-ov-file#getting-started](https://github.com/ososuna/cliplink-ui?tab=readme-ov-file#getting-started)
## License
Distributed under the Unlicense License.
## Contact
[Oswaldo Osuna](https://oswaldo-osuna.com) - [email protected]
Project Link: [https://github.com/ososuna/cliplink-rest.git](https://github.com/ososuna/cliplink-rest.git)
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/ososuna/
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[Astro]: https://img.shields.io/badge/Astro-FF5D01?style=for-the-badge&logo=astro&logoColor=white
[Astro-url]: https://astro.build/
[shadcn]: https://img.shields.io/badge/shadcn-0EA5E9?style=for-the-badge&logo=tailwindcss&logoColor=white
[shadcn-url]: https://ui.shadcn.com
[TailwindCSS]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwindcss&logoColor=white
[TailwindCSS-url]: https://tailwindcss.com/
[Vercel]: https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white
[Vercel-url]: https://vercel.com/
[Render]: https://img.shields.io/badge/Render-0095D5?style=for-the-badge&logo=render&logoColor=white
[Render-url]: https://render.com/
[MongoDB]: https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white
[MongoDB-url]: https://www.mongodb.com/
[MongoDB]: https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white
[MongoDB-url]: https://www.mongodb.com/
[Express.js]: https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white
[Express-url]: https://expressjs.com/