https://github.com/uiuxarghya/8bits
🔗 Fast, simple & serverless, URL shortener written in NextJS.
https://github.com/uiuxarghya/8bits
8bits api better-auth hacktoberfest mongodb mongodb-atlas nextjs open-source opensource react serverless serverless-functions serverless-url-shortner shadcn-ui typescript uiuxarghya url url-shortener vercel vercel-serverless
Last synced: 4 days ago
JSON representation
🔗 Fast, simple & serverless, URL shortener written in NextJS.
- Host: GitHub
- URL: https://github.com/uiuxarghya/8bits
- Owner: uiuxarghya
- License: agpl-3.0
- Created: 2021-04-12T21:21:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-26T23:18:42.000Z (14 days ago)
- Last Synced: 2025-04-27T00:18:57.738Z (13 days ago)
- Topics: 8bits, api, better-auth, hacktoberfest, mongodb, mongodb-atlas, nextjs, open-source, opensource, react, serverless, serverless-functions, serverless-url-shortner, shadcn-ui, typescript, uiuxarghya, url, url-shortener, vercel, vercel-serverless
- Language: TypeScript
- Homepage: https://8bits.vercel.app
- Size: 757 KB
- Stars: 31
- Watchers: 2
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
8bits
The Open Source Link Management platform.
Learn more →
## 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](https://better-auth.com).
- 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**](https://nextjs.org/) – The React framework for production.
- [**TypeScript**](https://www.typescriptlang.org/) – Strongly typed JavaScript for better developer experience.
- [**Tailwind CSS**](https://tailwindcss.com/) – A utility-first CSS framework for rapid UI development.
- [**shadcn/ui**](https://ui.shadcn.com) – Beautifully designed, accessible headless components built with Radix UI and Tailwind.
- [**Lucide Icons**](https://lucide.dev/) – A set of consistent and pixel-perfect icons.
- [**Prisma**](https://www.prisma.io/) – Modern database toolkit for TypeScript and Node.js.
- [**MongoDB**](https://www.mongodb.com/) – A NoSQL database for flexible and scalable data storage.
- [**Better Auth**](https://better-auth.com) – 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)](https://nodejs.org/en/)
- [Git](https://git-scm.com/)
- [bun](https://bun.sh/) (optional, for faster builds)
### Setup Instructions
1. **Fork** the repository and **clone** it locally:
```bash
git clone https://github.com/uiuxarghya/8bits.git
cd 8bits
```
2. **Install dependencies**:
```bash
bun install
```
3. **Run the development server**:
```bash
bun run dev
```
4. Open your browser and go to [http://localhost:3000](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.
For a list of contributors, visit the [contributors page](https://github.com/uiuxarghya/8bits/graphs/contributors).
## 🔑 License
This project is licensed under the [AGPL-3.0 license](https://github.com/uiuxarghya/8bits/blob/main/LICENSE).