get-started.md

layout	doc
title	Get Started

Get Started

Follow these concise steps to get DevPaper running locally, test content, and deploy.

Repository

Source code and examples: https://github.com/xoxxel/devpaper

1. Installation

Clone the repository and install dependencies:

git clone https://github.com/xoxxel/devpaper.git
cd devpaper
npm install    # or pnpm install

2. Start local development

Run the dev server with fast HMR for authoring and previewing content:

npm run dev    # or pnpm run dev
# open http://localhost:5173

If npm run dev fails, ensure Node 16+ is installed and dependencies completed.

3. Run tests (frontmatter & SEO checks)

npm test      # or pnpm test

The test suite includes frontmatter validation and SEO safety checks.

4. Build for production

npm run build    # or pnpm run build

The build produces pre-rendered HTML suitable for static hosting or inclusion in a Docker image.

5. Docker deployment (quick example)

docker build -t devpaper:latest .
docker run --rm -p 8080:80 devpaper:latest
# then open http://localhost:8080

Next steps

• Author a Markdown file in docs/ with required frontmatter (see docs/examples.md).
• Run npm test to validate frontmatter and generated metadata.
• Open an issue or PR on xoxxel/devpaper for contributions or questions.

Need me to run npm test or npm run build now?