dentalqore-qore
v2.4.2
Published
CLI tool to create a new DentalQore dental practice website
Maintainers
Readme
DentalQore
A CLI tool to quickly create a new dental practice website using the DentalQore template.
Quick Start
Option 1: npm (Recommended)
# Create a new site with interactive prompts
npx dentalqore-qore my-dental-practice
# Or skip prompts and use placeholders (customize later)
npx dentalqore-qore my-dental-practice --skip-promptsOption 2: Direct from GitHub
# Create a new site with interactive prompts
npx dentalqore-core my-dental-practice
# Or skip prompts and use placeholders (customize later)
npx dentalqore-core my-dental-practice --skip-promptsOption 3: Clone and Use Locally
# Clone the repository
git clone https://github.com/DentalQoreClientSites/dentalqore-core.git
cd dentalqore-core
# Install dependencies and build
npm install && npm run build
# Create a new site
node dist/index.js my-dental-practiceWhat it creates
This tool creates a complete Next.js dental practice website with:
- Modern Next.js 15 + React 19 - Latest web technologies
- TypeScript - Type-safe development
- Responsive Design - Mobile-first, works on all devices
- SEO Optimized - Built-in schema markup and meta tags
- Content Management - JSON-based page system
- Multi-location Support - Handle multiple practice locations
- Doctor Profiles - Showcase your dental team
- Service Pages - Highlight your dental services
- Contact Forms - Patient inquiry system
- Google Analytics - Track website performance
Usage
Interactive Setup (Recommended)
npx @dentalqore/qore awesome-dentalThe tool will prompt you for:
- Practice name
- Doctor information
- Address and contact details
- Website URL
- Location coordinates (optional)
Quick Setup with Placeholders
npx @dentalqore/qore awesome-dental --skip-promptsThis creates the site with placeholder values that you can customize later in src/config/site-info.ts.
After Creation
Navigate to your project:
cd your-practice-nameInstall dependencies:
npm installStart development server:
npm run devOpen your browser: Visit
http://localhost:3000to see your site
Customization
Practice Information
Edit src/config/site-info.ts to update:
- Practice and doctor details
- Contact information
- Office hours
- Services offered
Content Management
- Add pages:
src/content/pages/ - Update navigation:
src/content/navigation.json - Customize layouts: Choose from default, landing-page, full-width, sidebar
Environment Variables
Update .env.local with:
- Google Analytics ID
- Site URL
- Other configuration
Available Scripts
npm run dev- Start development servernpm run build- Build for productionnpm run start- Start production servernpm run generate:pages- Generate pages from JSON contentnpm run dev:watch- Development with auto page generation
Deployment
The generated site works with:
- AWS Amplify (recommended - includes
amplify.yml) - Vercel
- Netlify
- Any static hosting platform
Support
For detailed documentation, see the generated files in your project:
TEMPLATE-SETUP.md- Quick setup guideREADME.md- Complete documentationCONTENT-MANAGEMENT-GUIDE.md- Content editingSEO-CONFIGURATION-GUIDE.md- SEO optimization
Requirements
- Node.js 16 or higher
- npm or yarn
License
MIT
