Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashm20/staz
https://github.com/yashm20/staz
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/yashm20/staz
- Owner: YashM20
- Created: 2024-12-05T12:32:08.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-14T10:58:25.000Z (23 days ago)
- Last Synced: 2024-12-14T11:28:03.727Z (23 days ago)
- Language: TypeScript
- Size: 445 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Staz: Your All-in-One Bookmark Manager
💡 **Tag it. Stash it. Staz it.**
Reimagine how you save, organize, and retrieve your favorite links with Staz.
Staz is a modern, intuitive bookmark manager that helps you save web pages, songs, articles, or anything else while browsing. Designed for creatives and built for coders, Staz keeps your digital stash organized and accessible across devices.
## 🔗 Features
- **Collections**: Group bookmarks into context-specific collections.
- **Tags & Filters**: Classify items with tags and filter them efficiently by type, tags, or domain.
- **Duplicates and Broken Links**: Detect duplicates and inaccessible links to keep your library clean.
- **Permanent Copies**: Automatically archive web pages so you'll always have access.
- **Instant Previews**: Read articles, view videos, and browse content without leaving the app.
- **Multiple Views**: Choose between Grid, List, Headlines, or Masonry view modes.
- **Import & Export**: Easily move your bookmarks in and out of Staz.
## 🛠️ Built With
| Technology | Description |
|------------|-------------|
|  | Next.js for robust and scalable web applications |
|  | Drizzle ORM for type-safe database operations |
|  | Shadcn for reusable UI components |
|  | Tailwind CSS for modern and responsive designs |
|  | Motion.dev for smooth animations |
|  | Supabase for powerful backend services |
## 🚀 Getting Started
### Prerequisites
- Node.js 18+
- PNPM package manager
- PostgreSQL database
### Setup Steps
1. Clone the repository:
```bash
git clone https://github.com/yourusername/staz.git
cd staz
```
2. Install dependencies:
```bash
pnpm install
```
3. Set up environment variables:
```bash
cp .env.example .env.local
```
Edit `.env.local` and add your database credentials and other required variables.
4. Set up the database:
```bash
# Generate migration files
pnpm drizzle-kit generate
# Push schema changes to database
pnpm drizzle-kit push:pg
# Apply migrations
pnpm drizzle-kit migrate
```
5. Run the development server:
```bash
pnpm dev
```
### Database Management
Drizzle ORM commands available through pnpm scripts:
```bash
# Generate migration files from schema changes
pnpm db:generate
# Push schema changes directly to database
pnpm db:push
# Apply pending migrations
pnpm db:migrate
# Reset database (⚠️ Destructive operation)
pnpm db:reset
# Open Drizzle Studio
pnpm db:studio
```
### Database Schema
The database schema is organized into several modules:
- `users.ts`: User authentication and profile data
- `links.ts`: Core link management (domains, global links, user-specific links)
- `collections.ts`: Collections and sharing functionality
- `tags.ts`: Tag management system
- `activity.ts`: Activity logging
## 🤝 Contributing
We welcome contributions from the community! Here's how you can help:
1. Fork the repository
2. Create a new branch for your feature (`git checkout -b feature/NewFeature`)
3. Commit your changes (`git commit -m 'Add a new feature'`)
4. Push your branch (`git push origin feature/NewFeature`)
5. Open a pull request for review
Please ensure your PR adheres to our coding standards and includes appropriate tests.
## 📝 License
Distributed under the MIT License. See `LICENSE` for details.
## ⭐ Support the Project
If Staz makes your digital life easier, please give it a ⭐ on GitHub to show your support!
---