noisecanceller / README.md
raghu2's picture
fix: add Hugging Face YAML configuration block to README
62b04a6
|
Raw
History Blame Contribute Delete
3.22 kB
---
title: noisecanceller
emoji: 🎡
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
---
<div align="center">
<div style="background-color: #1877F2; width: 80px; height: 80px; border-radius: 16px; display: flex; align-items: center; justify-content: center; margin: 0 auto 20px;">
<span style="color: white; font-size: 40px; font-weight: bold; font-family: sans-serif;">S</span>
</div>
<h1>Stemify AI</h1>
<p><strong>The World's Best AI Vocal Extractor & Stem Separation Engine</strong></p>
<p>
<a href="https://github.com/Raghuvaranlokati/noisecanceller/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
<a href="https://nextjs.org/"><img src="https://img.shields.io/badge/Next.js-16-black?logo=next.js" alt="Next.js"></a>
<a href="https://tailwindcss.com/"><img src="https://img.shields.io/badge/Tailwind_CSS-v4-38B2AC?logo=tailwind-css" alt="Tailwind CSS"></a>
<a href="https://clerk.com/"><img src="https://img.shields.io/badge/Auth-Clerk-6C47FF?logo=clerk" alt="Clerk"></a>
</p>
</div>
---
## 🌟 About The Project
Stemify AI is a premium, open-source web application designed to extract high-quality vocals, drums, bass, and instruments from any audio or video file instantly using deep learning. It features a stunning pitch-black and electric blue UI, seamless Clerk authentication, and blazing fast performance powered by Next.js and Turbopack.
### Key Features
- **Industry-Leading Separation:** Isolate vocals and instruments with crystal clarity.
- **Next-Level UI/UX:** A gorgeous dark mode theme featuring fluid animations and glow effects.
- **Secure Authentication:** Built-in sign-in/sign-up flows powered by Clerk.
- **Modern Tech Stack:** Built with Next.js App Router, Tailwind CSS v4, and TypeScript.
---
## πŸš€ Getting Started
To get a local copy up and running, follow these simple steps.
### Prerequisites
- Node.js (v18 or higher)
- npm or yarn
- A [Clerk](https://clerk.com/) Account (for Authentication)
### Installation
1. **Clone the repository**
```sh
git clone https://github.com/Raghuvaranlokati/noisecanceller.git
cd noisecanceller/frontend
```
2. **Install dependencies**
```sh
npm install
```
3. **Set up environment variables**
Copy the example environment file and fill in your Clerk API keys:
```sh
cp .env.example .env.local
```
*Note: You can find your Clerk keys in your [Clerk Dashboard](https://dashboard.clerk.com).*
4. **Start the development server**
```sh
npm run dev
```
5. **Open the app**
Navigate to [http://localhost:3000](http://localhost:3000) in your browser.
---
## 🀝 Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a Pull Request.
---
## πŸ“„ License
Distributed under the MIT License. See `LICENSE` for more information.
---
<div align="center">
<p>Built with ❀️ by Raghuvaran Lokati and the open-source community.</p>
</div>