Skip to content

docs: Update README with React 19, Docker, testing, and CI/CD info#10

Closed
slmingol wants to merge 10 commits intoand-computers:mainfrom
slmingol:feature/update-readme
Closed

docs: Update README with React 19, Docker, testing, and CI/CD info#10
slmingol wants to merge 10 commits intoand-computers:mainfrom
slmingol:feature/update-readme

Conversation

@slmingol
Copy link
Copy Markdown

Overview

This PR updates the README to reflect all the recent improvements and modernizations to the project.

Changes

📚 Documentation Updates

Technology Stack:

  • Updated React 18 → React 19
  • Added Vitest + React Testing Library
  • Added Docker and multi-stage builds
  • Added Node 20 requirement

Setup Instructions:

  • Added Node 20 prerequisite
  • Documented --legacy-peer-deps flag requirement
  • Added comprehensive Docker instructions:
    • Local build with docker-compose
    • Pre-built GHCR image usage
  • Noted .nvmrc support for nvm users

Available Scripts:

  • Documented all npm scripts:
    • npm start - Dev server alias
    • npm test - Test watch mode
    • npm run test:run - CI test mode
    • npm run test:ui - Visual test interface
    • npm run format - Code formatting
    • npm run format:check - Format verification
                    • w
    • Format checks
    • Test execution
    • Build verification
    • Docker image publishing

ContributinContribnesContributinContribnesCoremContributinContrdeContributinContribnesConeqContributinContribnesContributitiContributinContribnesConakes it ContributinContribnes*s to get started

  • Clearly - Clearly - Clearly - Clrovem- Clearly - Clearly - Clearly - Clrovem- Clearly - pectations for PR quality

Dependencies

ThThThThThThThThThThThThThThThThThThR #5 (Docker support)

smingolelli and others added 10 commits February 20, 2026 22:00
- Add Dockerfile with Node.js build and Nginx production stages
- Add docker-compose.yml for local development with build
- Add docker-compose.simple.yml for running from GHCR
- Add .dockerignore to optimize build context
- Use Debian-based Node image for ARM compatibility
- Upgrade React & React DOM to v19.2.4
- Upgrade date-fns from v2 to v4
- Upgrade prettier from v2 to v3
- Upgrade react-spring from v9 to v10
- Upgrade query-string from v8 to v9
- Upgrade tailwind-merge from v1 to v3
- Upgrade ua-parser-js from v1 to v2
- Upgrade Parcel to v2.16.4
- Upgrade lucide-react to v0.575.0
- Upgrade Tailwind CSS to v3.4.19
- Upgrade all @radix-ui packages to latest versions
- Upgrade other dependencies to latest compatible versions

All tests passing with legacy peer deps for React 19 compatibility
- Upgrade to Node 20 (required by rimraf@6 and other packages)
- Switch from npm ci to npm install --legacy-peer-deps for React 19
- Upgrade to Node 20 (required by rimraf@6 and other packages)
- Switch from npm ci to npm install --legacy-peer-deps for React 19
chore: Update Dockerfile for React 19 compatibility
- Remove obsolete docker-compose version attribute
- Update dev service from Node 18 to Node 20
- Remove unused eslint and eslint-config-react-app packages
- Add package overrides to force secure versions of minimatch and glob
- Fixes all 21 high severity security vulnerabilities (now 0)

This resolves GHSA-3ppc-4f35-3m26 (minimatch ReDoS vulnerability) and
eliminates all transitive dependencies on vulnerable package versions.
fix: Address critical security and configuration issues
- Add .nvmrc for consistent Node 20 environment
- Enhance package.json scripts (start, clean, format, format:check, test)
- Add GitHub Actions CI/CD workflow
  - Runs on push to main and PRs
  - Format check, tests, and build verification
  - Docker image build and push to GHCR (main branch only)
- Setup Vitest testing framework
  - Configured for JSX support in .js files
  - Includes React Testing Library and jsdom
  - Added example test for WordButton component
  - Test scripts: test, test:ui, test:run, test:coverage

All tests passing (4/4) with 0 vulnerabilities maintained.
feat: Add developer experience improvements
- Update React 18 → React 19
- Add Node 20 prerequisite and .nvmrc mention
- Add Docker setup instructions (local build and GHCR image)
- Document all npm scripts (start, test, format, clean, etc.)
- Add testing section with Vitest and React Testing Library
- Add CI/CD section explaining GitHub Actions workflow
- Enhance Contributing section with development requirements
- Note --legacy-peer-deps flag requirement
- Add technology stack updates (Vitest, Docker, Node 20)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants