How ciromirkin/boar works
Project type and purpose
• Boar is a single-page web application built with React and TypeScript.
• Purpose: organize tasks with boards, columns, and an archive, all in the browser.
File structure
Top-level groupings:
• public/ & index.html – static assets, Netlify config (hosting)
• src/ – main application code
– ui/ – low-level UI primitives (buttons, inputs, dialogs, etc.)
– sharedByModules/ – cross-cutting concerns (Header, Theme, hooks, utils)
– modules/ – domain features broken out by area (board, columnList, taskList, archive, reminder)
– lib/ – generic utilities
– i18next/ – internationalization setup
– Router.tsx, App.tsx – top-level container and routing
– store.ts – centralized state management wiring reducers
• docs/ – documentation
• cypress.config.ts – end-to-end tests
• configuration files – ESLint, Prettier, Vite, Tailwind, TS
Additional insights from README
• SPA to create, move, delete, archive tasks across user-definable columns.
• Uses unit tests (in-repo .test.ts files) and Cypress for quality.
• Deploys to Netlify (public/netlify.toml).
Main components
a. User’s Browser (Client)
b. React Application – subdivided into:
• Presentation Layer
– Router & Pages (App, 404, Help, Configs)
– UI primitives (ui/)
– Feature components (modules/.../components)
• State Management Layer
– store.ts (combines reducers)
– Reducers & Actions per domain: boardReducer, columnListReducer, taskListReducers, archiveReducer, reminder context
– Persistence adapters (localStorageBoard, localStorageColumnList, localStorageTaskLists, localStorageArchive)
• Domain Layer (modules/…/models & repositories)
– Domain models (Board, Column, Task, Archive)
– Repositories for data access abstraction over localStorage
• Cross-cutting services
– i18next internationalization
– ThemeContext & Language toggle
– ErrorBoundary
– Utilities (getErrorMessage, getTime, etc.)
c. Browser LocalStorage (persistent client storage)
d. Build & Deployment pipeline
• Vite (vite.config.ts) → bundled static assets
• Netlify hosting (public/netlify.toml, _redirects)
Relationships & interactions
• User events → React components → dispatch Actions → Reducers update State → Persist to localStorage → Components re-render
• Router drives which page/component tree mounts
• Shared services (i18n, ThemeContext) wrap App and inject configuration into components
• Build pipeline: source files → Vite → static assets → Netlify → CDN → User’s browser
Architectural patterns & principles
• Component-based UI (React + functional components + hooks)
• Unidirectional data flow (Flux-style actions → reducers → state → view)
• Separation of concerns: UI primitives vs feature components vs state vs persistence
• Domain modeling: each module has its own models, actions, reducers, persistence adapter
• Context API for cross-cutting features (theme, reminders, language)
Relevant technologies & frameworks
• React, React Router, React Context, Hooks
• TypeScript
• Vite for build
• Tailwind CSS for styling
• i18next for localization
• Cypress for E2E testing, Jest for unit tests
• Netlify for hosting