Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codernotme/vybe
VYBE - Connect, Collaborate, and Thrive 🚀
https://github.com/codernotme/vybe
clerk clerk-auth clerkauth collaborate community convex nextjs nextui react real-time shadcn-ui tailwindcss typescript webapp
Last synced: 8 days ago
JSON representation
VYBE - Connect, Collaborate, and Thrive 🚀
- Host: GitHub
- URL: https://github.com/codernotme/vybe
- Owner: codernotme
- License: other
- Created: 2024-11-08T05:26:08.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T14:32:01.000Z (13 days ago)
- Last Synced: 2025-01-24T15:28:39.110Z (13 days ago)
- Topics: clerk, clerk-auth, clerkauth, collaborate, community, convex, nextjs, nextui, react, real-time, shadcn-ui, tailwindcss, typescript, webapp
- Language: TypeScript
- Homepage: https://vybe-nu.vercel.app
- Size: 3.08 MB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# VYBE - Connect, Collaborate, and Thrive 🚀
VYBE is a unique social platform that empowers students, mentors, and communities within colleges to connect meaningfully. Designed to foster collaboration, build communities, and facilitate mentorship, VYBE redefines campus social interactions.
---
## 🛠️ Tech Stack
- **Frontend**: Next.js, NextUI, TypeScript, TailwindCSS
- **Authentication**: Clerk
- **Database & State Management**: Convex, Redis
- **Containerization**: Docker
---
## ✨ Features
### User Types
- **Normal User**: Post content, chat, share stories, join group chats, follow communities, and participate in anonymous discussions.
- **Tech User**: All features of a Normal User + access to a project workbench, GitHub integration, and collaborative tools.
- **Community View**: Stay updated on public events, club posts, and community announcements.
- **Mentor View**: Guide students, connect with peers, and oversee projects.
- **Admin View**: Manage users, moderate content, and supervise platform activities.
### Key Highlights
- **Project Workbench**: Collaborate on tech projects with public GitHub repositories, creating vibrant communities around shared goals.
- **Anonymous Networking**: Safely exchange ideas and collaborate without revealing identities.
- **Event Management**: Stay on top of campus happenings, club activities, and key announcements.
- **Real-Time Chat**: Engage in dynamic group chats, private messaging, and immersive stories.
---
## 🚀 Getting Started
### Prerequisites
Ensure the following are installed:
- **Node.js** (v18+)
- **Docker**
- **Git**
---
### Installation
1. Clone the repository:
```bash
git clone https://github.com/codernotme/vybe.git
cd vybe
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
- Create a `.env.local` file and add the following keys:
```env
# Clerk Configuration
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
CLERK_JWT_ISSUER_DOMAIN=
# Convex Configuration
CONVEX_DEPLOYMENT=
NEXT_PUBLIC_CONVEX_URL=
# YouTube API Key
NEXT_PUBLIC_YOUTUBE_API_KEY=
```
Replace placeholders with your actual credentials.
4. Start the application:
```bash
docker-compose up --build
```
5. Open the app:
```
http://localhost:3000
```
---
## 🛠️ Additional Setup
### Enabling Convex
1. **Set Up Convex**:
- Visit the [Convex Dashboard](https://dashboard.convex.dev/) and create a project.
2. **Deploy Convex Functions**:
- Initialize Convex locally:
```bash
npx convex dev
```
- Deploy the Convex functions:
```bash
npx convex deploy
```
- Add the `CONVEX_DEPLOYMENT` ID (e.g., `dev:moonlit-crow-448`) to your `.env.local` file.
3. **Install Convex**:
```bash
npm install convex
```
### Integrating Clerk with Convex
1. Install necessary packages:
```bash
npm install convex @clerk/nextjs
```
2. Configure Clerk JWT for Convex authentication:
- Set up middleware to validate tokens.
Refer to [Clerk Docs](https://clerk.com/docs/) and [Convex Docs](https://docs.convex.dev/auth/clerk) for details.
---
### Make sure your Convex and Clerk must have these following -
1) **Clerk**
2) **Convex**
### Securing Environment Variables
To ensure security, exclude `.env.local` from version control by adding it to `.gitignore`:
```bash
.env.local
```
---
## 📂 Project Structure
```
vybe/
├── components/ # Reusable UI components
├── app/ # Application entry points and pages
├── utils/ # Utility functions and helpers
├── styles/ # Global styles and themes
├── hooks/ # Custom React hooks
└── services/ # API services and integrations
```
---
## 📄 License
This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
For more details, see the [LICENSE](./LICENSE) file.
---
## 🤝 Contributing
We welcome contributions! Please review our [Contributing Guide](CONTRIBUTING.md) for guidelines.
---
## 📬 Contact
Questions or feedback? Reach out to **[email protected]**.
---
## Preview
