Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 4.91 KB

README.md

File metadata and controls

98 lines (62 loc) · 4.91 KB

8bits Link Shortner   GitHub release (latest by date) Website


A simple serverless url shortenener. Built with ❤︎ by Arghya Ghosh.

📄 About

8bits Link Shortener is a simple serverless url shortener with MongoDB and Vercel. It helps you shorten long links for easy sharing.

🎯 Features

  • ⚡️ Fast: Paste long url and get/copy short url in less than a second.
  • ❤️ Lightweight & Simple: Crafted with minimalistic UI design.
  • 🔒 Secure by Design: Since it's serverless, it's secure.

📖 Documentation

To know in-depth about 8bits Link Shortener, please visit the documentation.

⚙️ Buitlt With

  • Next.js - The React Framework for Production.
  • Ant Design - A design language for React.
  • MongoDB - A document-oriented database.
  • Vercel - A hosting platform for modern web apps.

✨ Getting Started

Prerequisites

  1. A basic understanding of the Next.js framework is required.
  2. You should have Vercel CLI installed.
  3. A MongoDB database is required.
  4. A Vercel account is required.

Variables reference

Please note that entered values are case-sensitive. Default values are provided as an example to help you figure out what should be entered.

On Vercel, you have to add the following Environment Variables to your project while deploying to production.

Variable Default Value Description
MONGODB_URI mongodb+srv://cluster0.example.mongodb.net MongoDB connection string.
NEXT_PUBLIC_VERCEL_URL https://8bits.vercel.app or https://example.com Vercel URL or your custom domain.

Usage

To develop locally

  1. Clone the repository.
  $ git clone https://github.com/uiuxarghya/8bits.git
  $ cd 8bits
  $ npm install
  1. Create a .env.local file repository's root directory with your own keys.
  MONGODB_URI=""
  NEXT_PUBLIC_VERCEL_URL=""
  1. Run vercel dev to start the development server and open the browser at http://localhost:3000.

OR

Deploy now with Vercel

Deploy with Vercel

Provide the following environment variables to your Vercel project.

👍 Contribute

If you want to say thank you and/or support the active development of 8bits:

👦 Author

⚖️ License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.