🔗 satvik-github-explorer-username.vercel.app

This website is built with Next.js, Tailwind CSS, and deployed to preview(https://vercel.com/). Some ideas borrowed from Jirihofman (https://github.com/jirihofman).

Data about user and projects are gathered via GitHub API.

Tech stack

• Framework: Next.js
• Deployment: Vercel
• Styling: Tailwind CSS

Running Locally

git clone https://github.com/satviktripathi369/github-explorer.git
cd portfolio

Create a .env file similar to [.env.example].

mv .env.example .env.local

Add GitHub token into the new file.

GH_TOKEN=YOUR_GH_TOKEN
# If you have Vercel projects, create a token here https://vercel.com/account/tokens to get more info.
VC_TOKEN=YOUR_VERCEL_TOKEN

Then install dependencies and run the development server:

# Install dependencies.
npm install
# Replace my personal info with yours.
npm run setup
# Start hacking.
npm dev

Edit data.json to put your personal information there.

Cloning / Forking

Please remove all of my personal information in data.json before deploying your own version of this site by running npm run setup. Once you are happy with your data.json, set

# .env or .env.local

IS_TEMPLATE=false

in your ENVs to prevent npm build from reverting data.json back to my previous data.

To check before deploying

• data.json: githubUsername, description, heroNames. Handled by setup.mjs.
• README.md: link at the top
• app/layout.jsx: metadata - title, description, favicon. Handled by setup.mjs.
• public/favicon.ico. Handled by setup.mjs.