Getting Started

Welcome to EnjuFolio 👋 This page is the shortest path from “I found this template” to “it runs with my name on it”.

1. Create your own copy

You have two main options:

Option A · One-click deploy (Vercel)

If you just want a live site quickly:

1. Click the Deploy with Vercel button down below.
2. Connect your GitHub account.
3. Wait for the first deployment to finish.

Vercel will:

• Clone the repo to your GitHub
• Create a project
• Set up builds for you

After that, you only need to edit configuration and content in your fork.

TIP

Already deployed from the README button? Great — you can jump straight to Update configuration.

Option B · Clone & run locally

If you prefer to start on your machine:

pnpm

git clone https://github.com/ZL-Asica/EnjuFolio.git
cd EnjuFolio
pnpm install
pnpm dev

npm

# Remove pnpm-lock.yaml if you want to use npm
git clone https://github.com/ZL-Asica/EnjuFolio.git
cd EnjuFolio
npm install
npm run dev

yarn

# Remove pnpm-lock.yaml if you want to use yarn
git clone https://github.com/ZL-Asica/EnjuFolio.git
cd EnjuFolio
yarn install
yarn dev

Then open:

http://localhost:3000

You should see the default EnjuFolio site.

2. Local development

For configuration changes and content writing, life will be much smoother if you editing and previewing locally. See the full guide here:

• Local Development Guide

3. Update the configuration

Most personalization lives in a single file:

src/enju.config.ts

Start by changing:

• title, subTitle, description
• homePage.name, homePage.picture
• socialLinks (GitHub, LinkedIn, etc.)
• cvFileLink (link to your Google Drive file or CV PDF)

TIP

You don’t need to understand every field on day one. Get your name, avatar, and basic links right first — then come back to refine the rest.

4. Add your content

Once the basics are set, you can start replacing the demo content:

• src/contents/research → your research projects / papers
• src/contents/projects → your tools, apps, or side projects
• src/contents/news → updates, talks, or announcements

All of these are MDX files, so you can mix Markdown and React components.

For details on how content is organized, see:

• Content & Sections

What’s next?

Once your site is running with your name on it, you might want to:

• Start customizing the configuration → Configuration Guide
• Write your first content → Content & Sections
• Fine-tune metadata, JSON-LD, llms.txt → Meta Info & SEO
• Customize styling or components → Customization Guide

Take your time. EnjuFolio is meant to be a small, calm place for your work — you don’t have to finish everything in one sitting.