https://github.com/eep-dev/eep-site
https://github.com/eep-dev/eep-site
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eep-dev/eep-site
- Owner: eep-dev
- Created: 2026-04-15T20:55:13.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-20T00:10:16.000Z (about 1 month ago)
- Last Synced: 2026-05-20T07:25:06.062Z (about 1 month ago)
- Language: TypeScript
- Size: 1.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EEP Landing Site (`eep-site`)
Official landing page repository for the EEP ecosystem under the `eep-dev` organization.
- EEP protocol repository: [https://github.com/eep-dev/EEP](https://github.com/eep-dev/EEP)
- EEP landing page repository: [https://github.com/eep-dev/eep-site](https://github.com/eep-dev/eep-site)
## Purpose
This site is the public-facing documentation and landing experience for EEP.
It must stay aligned with:
- Protocol repo: [https://github.com/eep-dev/EEP](https://github.com/eep-dev/EEP)
- Landing repo: [https://github.com/eep-dev/eep-site](https://github.com/eep-dev/eep-site)
- Package scopes: npm `@eep-dev/*`, Python `eep-*`
## Getting Started
Run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) to preview the site.
Edit `app/page.tsx` and related components; the page auto-updates during development.
## Content Alignment Checklist
Before release, confirm these are reflected in site content:
- Strict fail-closed semantic verification defaults
- Zero-trust audit readiness and report links
- Compliance scoring and `--report-json` / `--report-md` examples
- Canonical adoption links (agent onboarding + enterprise playbook)
- Repository URLs under `eep-dev`
## Whitepaper PDF (`/whitepaper`)
The site serves the EEP technical whitepaper as a paginated PDF at `/whitepaper` (production: `https://eep.dev/whitepaper`).
Before `npm run build`, generate the PDF in the protocol repo and let prebuild copy it into `public/docs/`:
```bash
cd ../EEP/docs && pdflatex WHITEPAPER.tex && pdflatex WHITEPAPER.tex
cd ../../eep-site && npm install && npm run build
```
`postinstall` / `prebuild` also copy `pdf.worker.min.mjs` from `pdfjs-dist` for the in-browser viewer.
## Deployment
Deploy using your preferred platform (Vercel, Netlify, container-based deployment, etc.).
Keep production environment variables and domain configuration in sync with the `eep-dev` organization setup.
For production, ensure `WHITEPAPER.pdf` exists at build time (run `pdflatex` in CI or commit `public/docs/WHITEPAPER.pdf` after each whitepaper release).
**Docker (`docker compose build`):** the image copies `scripts/` before `npm ci` (postinstall needs them). The build context is only `eep-site/`, so commit `public/docs/WHITEPAPER.pdf` or generate it locally before `docker compose up --build` — the container cannot reach `../EEP/docs`.