https://github.com/networkflux/ycdirectory
https://github.com/networkflux/ycdirectory
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/networkflux/ycdirectory
- Owner: NetworkFlux
- Created: 2025-02-27T17:50:32.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-02-28T18:14:44.000Z (3 months ago)
- Last Synced: 2025-02-28T22:28:48.956Z (3 months ago)
- Language: TypeScript
- Size: 983 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 📋 Table of Contents
1. 🤖 [Introduction](#introduction)
2. ⚙️ [Tech Stack](#tech-stack)
3. 🔋 [Features](#features)
4. 🤸 [Quick Start](#quick-start)
A Full Stack Next.js 15 platform where entrepreneurs can submit their startup ideas for virtual pitch competitions, browse other
pitches, and gain exposure through a clean minimalistic design for a smooth user experience.
This project showcases the latest features of Next.js 15, including Next.js Form for seamless client-side form submissions, Unstable After for background tasks, Server Component HMR Cache for faster development, and Partial Prerendering for performance optimization.
Visit the app by going here: https://yc-directory-two-beta.vercel.app/
- React 19
- Next.js 15
- Sanity
- TailwindCSS
- ShadCN
- TypeScript
- Sentry
## 🔋 Features
👉 **Live Content API**: Displays the latest startup ideas dynamically on the homepage using Sanity's Content API.
👉 **GitHub Authentication**: Allows users to log in easily using their GitHub account.
👉 **Pitch Submission**: Users can submit startup ideas, including title, description, category, and multimedia links (
image or video).
👉 **View Pitches**: Browse through submitted ideas with filtering options by category.
👉 **Pitch Details Page**: Click on any pitch to view its details, with multimedia and description displayed.
👉 **Profile Page**: Users can view the list of pitches they've submitted.
👉 **Editor Picks**: Admins can highlight top startup ideas using the "Editor Picks" feature managed via Sanity Studio.
👉 **Views Counter**: Tracks the number of views for each pitch instead of an upvote system.
👉 **Search**: Search functionality to load and view pitches efficiently.
👉 **Minimalistic Design**: Fresh and simple UI with only the essential pages for ease of use and a clean aesthetic.
👉 **Error Management**: Complete error and issues management with Sentry, including full traceback with video replay.
and many more, including the latest **React 19**, **Next.js 15** and **Sanity** features alongside code architecture and
reusability
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone https://github.com/NetworkFlux/YCDirectory
cd YCDirectory
```
**Installation**
Install the project dependencies using npm:
```bash
npm install
```
**Set Up Environment Variables**
Create a new file named `.env.local` in the root of your project and add the following content:
```env
NEXT_PUBLIC_SANITY_PROJECT_ID=
NEXT_PUBLIC_SANITY_DATASET=
NEXT_PUBLIC_SANITY_API_VERSION='vX'
SANITY_TOKEN=
AUTH_SECRET=
AUTH_GITHUB_ID=
AUTH_GITHUB_SECRET=
```
Replace the placeholder values with your actual Sanity credentials. You can obtain these credentials by signing up &
creating a new project on the [Sanity website](https://www.sanity.io/).
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.