NYSDS Project Forge

A starter template for building projects with the New York State Design System (NYSDS).

Overview

This template provides a quick way to scaffold new projects that use the NYS Design System. It includes pre-configured templates, common patterns, and all the necessary setup to get you started quickly.

Getting Started

Prerequisites

• Node.js 18 or higher
• npm or yarn

Installation

1. Clone or download this template
2. Run the setup script:

npm install
npm run setup

Or use the bash fallback:

./setup.sh

3. Follow the interactive prompts to configure your project

What's Included

• Templates: Pre-configured Vite and static HTML templates
• Patterns: Common UI patterns for NYS applications
• Fonts: Proxima Nova and D-DIN font files
• GitHub Workflows: CI/CD configurations for deployment

Project Structure

nysds-project-starter/
├── fonts/              # Licensed font files
├── templates/
│   ├── vite/           # Vite-based template
│   ├── static/         # Static HTML template
│   ├── patterns/       # UI pattern templates
│   └── github/         # GitHub workflow templates
├── lib/                # Shared utilities
├── setup.js            # Interactive setup script
└── setup.sh            # Bash fallback script

License

This project is licensed under the terms specified by New York State.

Support

For questions or issues, please contact the NYS Digital Services team.