This section contains practical guides for developers working with the Small Dev Talk codebase.
The developer guides provide step-by-step instructions for common tasks, from setting up a local environment to publishing new articles and running validation scripts.
Complete setup guide for local development.
What you'll learn:
- Installing dependencies
- Running the local development server
- Understanding the project structure
- Configuring development tools (ESLint, Prettier, Markdownlint)
Step-by-step guide for adding new articles to Small Dev Talk.
What you'll learn:
- Article directory structure requirements
- Creating article metadata entries
- Writing markdown content
- Adding images and media
- Updating the Service Worker cache
- Testing articles locally
- Publishing workflow
Guide to running tests and ensuring code quality.
What you'll learn:
- Running Jest unit tests
- Running Cypress E2E tests
- Code linting with ESLint
- Code formatting with Prettier
- Markdown validation
- Full validation pipeline
- Continuous Integration (CI) process
Deployment and build notes based on repository scripts and workflows.
What you'll learn:
- Service worker generation for precaching
- Repository deployment notes based on current workflows
# Local development
npm run start # Start dev server on port 3000
# Testing
npm run test # Run Jest unit tests
npm run cypress # Open Cypress test runner
npm run e2e:headless # Run E2E tests in CI mode
# Code Quality
npm run eslint # Fix ESLint errors
npm run prettier # Format all files
npm run lint:markdown # Validate markdown files
# Service worker
npm run workbox # Regenerate Service Worker cache
# Full Validation
npm run validate # Run all checksImplementation: package.json
- System Architecture — Understanding the codebase structure
- Data Flow — How data moves through the application
- ArticleFiller API — Core module documentation