8bits

<a href="https://8bits.vercel.app"> <img src="https://repository-images.githubusercontent.com/357342595/8f3d45e8-47ab-4e1b-a324-b2f305380f7e"> </a> <h3 align="center">8bits</h3> <p align="center"> The Open Source Link Management platform. <br/> <a href="https://8bits.vercel.app" target="_blank">Learn more →</a> </div> <div align="center"> <a href="#introduction" target="_blank"> Introduction </a> <span>&nbsp;✦&nbsp;</span> <a href="#-features" target="_blank"> Features </a> <span>&nbsp;✦&nbsp;</span> <a href="#-getting-started"> Getting Started </a> <span>&nbsp;✦&nbsp;</span> <a href="#-contributing"> Contributing </a> </div> </p> <div align="center">

</div>

Introduction

8bits is a simple and secure link shortening service that allows users to create custom short links. It is built using modern web technologies and offers a smooth and efficient experience for managing short URLs.

✨ Features

• Create short links with custom aliases.
• Secure user authentication with Better Auth.
• A simple and easy-to-use interface to manage links.
• Support for both individual users and teams with workspace management (Coming Soon)

🛠️ Stack

• Next.js – The React framework for production.
• TypeScript – Strongly typed JavaScript for better developer experience.
• Tailwind CSS – A utility-first CSS framework for rapid UI development.
• shadcn/ui – Beautifully designed, accessible headless components built with Radix UI and Tailwind.
• Lucide Icons – A set of consistent and pixel-perfect icons.
• Prisma – Modern database toolkit for TypeScript and Node.js.
• MongoDB – A NoSQL database for flexible and scalable data storage.
• Better Auth – A simple and secure authentication system built for modern web apps.

🚀 Getting Started

To get started with 8bits, you'll need to set up the project locally. Follow the steps below:

Prerequisites

Make sure you have the following installed:

• Node.js 20+ (recommended 22 LTS)
• Git
• bun (optional, for faster builds)

Setup Instructions

1. Fork the repository and clone it locally:

   git clone https://github.com/arghyaxcodes/8bits.git
   cd 8bits
   

2. Install dependencies:

   bun install
   

3. Run the development server:

   bun run dev
   

4. Open your browser and go to http://localhost:3000.

🤝 Contributing

We welcome contributions to 8bits! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Clone your fork locally.
3. Create a new branch and make your changes.
4. Test your changes locally.
5. Create a pull request with a clear description of your changes.

🧑🏻‍💻 Contributors

<a href="https://github.com/arghyaxcodes/8bits/graphs/contributors"> <img src="https://contrib.rocks/image?repo=arghyaxcodes/8bits" /> </a>

For a list of contributors, visit the contributors page.

🔑 License

This project is licensed under the AGPL-3.0 license.