Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.66 KB

README.md

File metadata and controls

87 lines (60 loc) · 2.66 KB

Project Banner
typescript nextdotjs tailwindcss sanity

Startup Directory Platform

🤖 Introduction

A 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.

⚙️ Tech Stack

  • React 19
  • Next.js 15
  • Sanity
  • TailwindCSS
  • ShadCN
  • TypeScript

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

Cloning the Repository

git clone https://github.com/kTz1/yc_directory
cd yc_directory

Installation

Install the project dependencies using npm:

npm install

Set Up Environment Variables

Create a new file named .env.local in the root of your project and add the following content:

NEXT_PUBLIC_SANITY_PROJECT_ID=
NEXT_PUBLIC_SANITY_DATASET=
NEXT_PUBLIC_SANITY_API_VERSION=
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.

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project.

🚀 Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.