Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shivabhattacharjee/trim
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
https://github.com/shivabhattacharjee/trim
dockercompose eslint nextjs14 postgresql prettier prisma serverless tailwindcss typescript url-shortener vercel
Last synced: 3 months ago
JSON representation
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
- Host: GitHub
- URL: https://github.com/shivabhattacharjee/trim
- Owner: ShivaBhattacharjee
- License: apache-2.0
- Created: 2024-03-29T10:37:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-15T09:13:48.000Z (6 months ago)
- Last Synced: 2024-10-11T12:22:59.736Z (3 months ago)
- Topics: dockercompose, eslint, nextjs14, postgresql, prettier, prisma, serverless, tailwindcss, typescript, url-shortener, vercel
- Language: TypeScript
- Homepage: https://trim.theshiva.xyz/
- Size: 628 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Trim
[](https://github.com/prettier/prettier)
Trim: Shorten Your Urls
View Demo
.
Report Bug
.
Request Feature
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Docker](#docker)
- [Host your own](#host-your-own)
- [Contributing](#contributing)
- [Creating A Pull Request](#creating-a-pull-request)
- [Raising an issue](#raising-an-issue)
- [Code of conduct](#code-of-conduct)
- [License](#license)
- [Authors](#authors)
## About The Project
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
* [Bun](https://bun.sh/)
* [NextJS](https://nextjs.org)
* [TailwindCss](https://tailwindcss.com/)
* [MONGODB](https://www.mongodb.com/)
## 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
```bash
git clone https://github.com/ShivaBhattacharjee/Trim
```
```bash
cd Trim
```
```bash
cp .env.example .env
```
Database can be started by docker compose by
```bash
docker compose up
```
Fill the required fields inside the .env before starting the server ,only if you didnt start the database by docker compose
```bash
bun install
```
```bash
bun migrate:dev
```
```bash
bun dev
```
This will start the development server at http://localhost:3000/
## Docker
Image will be available soon
## Host your own
* ## Vercel
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FShivaBhattacharjee%2FTrim)
* ## Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/ShivaBhattacharjee/Trim)
* ## Render
[](https://render.com/deploy?repo=https://github.com/ShivaBhattacharjee/Trim)
## 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](https://github.com/ShivaBhattacharjee/Trim/issues) 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](https://github.com/ShivaBhattacharjee/Trim/tree/main/.github/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](https://github.com/ShivaBhattacharjee/Trim/blob/main/LICENSE) for more information.
## Authors
* **Shiva Bhattacharjee** - [Shiva Bhattacharjee](https://github.com/ShivaBhattacharjee) - *Trim*