Skip to content
/ Trim Public template

Trim is a sleek and efficient URL shortener project developed using Next.js . With Trim, users can easily shorten lengthy URLs into concise, manageable links, making sharing and distributing web addresses more convenient

License

Notifications You must be signed in to change notification settings

ShivaBhattacharjee/Trim

Repository files navigation


Trim

NextJs code style: prettier GitHub repo size

Trim: Shorten Your Urls

View Demo . Report Bug . Request Feature

Table Of Contents

About The Project

Screenshot from 2024-03-30 11-30-35

Screenshot from 2024-03-30 11-31-56

Trim is a sleek and efficient URL shortener project developed using Next.js. With Trim, users can easily shorten lengthy URLs into concise, manageable links, making sharing and distributing web addresses more convenient. The project incorporates Next.js's for server-side rendering. Trim prioritizes simplicity and effectiveness, offering a streamlined interface for users to swiftly generate shortened URLs with just a few clicks. Whether for social media sharing, email campaigns, or any other online communication, Trim empowers users to effortlessly shorten URLs and streamline their online presence.

Built With

Trim is built using NextJs

Getting Started

Prerequisites

Git is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.

Bun is a JavaScript runtime, package manager, test runner bundler built from scratch using the Zig programming language. It was designed by Jarred Sumner as a drop-in replacement for Node.js. Bun uses JavaScriptCore as the JavaScript engine, unlike Node.js and Deno, which both use V8.

postgresql also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

DockerDocker is a set of platform as a service products that use OS-level virtualization to deliver software in packages called containers. The service has both free and premium tiers. The software that hosts the containers is called Docker Engine. It was first released in 2013 and is developed by Docker, Inc.

Installation

This project utilises Bun. Install it before running locally

git clone https://github.com/ShivaBhattacharjee/Trim
cd Trim
cp .env.example .env

Database can be started by docker compose by

docker compose up

Fill the required fields inside the .env before starting the server ,only if you didnt start the database by docker compose

bun install
bun migrate:dev
bun dev

This will start the development server at http://localhost:3000/

Docker

Image will be available soon

Host your own

  • Vercel

Deploy with Vercel

  • Netlify

Deploy to Netlify

  • Render

Deploy to Render

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it

  • Please make sure you check your spelling and grammar.

Creating A Pull Request

Wanna contribute to Trim ?

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/FeatureName)
  3. Commit your Changes (git commit -m 'Add some FeatureName')
  4. Push to the Branch (git push origin feature/FeatureName)
  5. Open a Pull Request

Raising an issue

If you're experiencing any problems with Quibble, please be sure to review our issue template before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing, and it will ensure that we have all of the necessary information to investigate the problem.

We kindly ask that you provide as much detail as possible when submitting an issue, including steps to reproduce the problem, any error messages that you have seen, and any other relevant information. This will help us to identify and fix the issue more quickly.

Thank you for your cooperation, and we look forward to hearing from you!

Code of conduct

Developers are requested to go through our code of conduct thoroughly to maintain a peaceful environment within our project.

License

Distributed under the Apache License 2.0 . See LICENSE for more information.

Authors

About

Trim is a sleek and efficient URL shortener project developed using Next.js . With Trim, users can easily shorten lengthy URLs into concise, manageable links, making sharing and distributing web addresses more convenient

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published