How rohan-shridhar/gridcraft works
GridCraft is a browser-based art and collaboration workspace whose artwork library lives in each creator’s GitHub repository. The main workflow is GitHub sign-in, album browsing, canvas editing and saving, with Stories, branch workflows, forks, and GridCraft-native Issues and Pull Requests as distinct capabilities. The frontend calls an Express API; backend controllers coordinate domain services, which use GitHub for artwork-library operations. The README documents capabilities beyond the sampled implementation, so those branches are included while uncertain internal links are omitted.
Main entry points: albumRoutes.js Album routes · authController.js OAuth API · App.jsx Workspace shell · ArtworkEditor.jsx Artwork editor
Components 32
Workspace frontend
- Workspace shell
src/App.jsx - Auth state
src/hooks/useAuth.jsx - API client
src/services/apiClient.js - Album workspace
src/components/AlbumDetail.jsx - Artwork editor
src/components/ArtworkEditor.jsx - Canvas controls
src/Tools.jsx - Drawing grid
src/Grid.jsx
Authentication
- OAuth API
server/src/controllers/authController.js - GitHub auth service
server/src/services/githubAuthService.js - Session middleware
server/src/middleware/auth.js - Session cryptography
server/src/utils/crypto.js
Artwork library
- Album API
server/src/controllers/albumController.js - Artwork API
server/src/controllers/artworkController.js - Story API
server/src/controllers/storyController.js - Branch API
server/src/controllers/branchController.js - Album service
server/src/services/albumService.js - Artwork service
server/src/services/artworkService.js - Story service
server/src/services/storyService.js - Branch service
server/src/services/branchService.js
Collaboration
- Issues API
server/src/controllers/issueController.js - Issues service
server/src/services/issueService.js - Pull requests API
server/src/controllers/pullRequestController.js - Pull requests service
server/src/services/pullRequestService.js - Album fork API
server/src/controllers/forkController.js - Album fork service
server/src/services/forkService.js
API runtime
- Express API
server/src/app.js - Album routes
server/src/routes/albumRoutes.js - GitHub client
server/src/utils/githubClient.js - Runtime configuration
server/src/config/env.js
Other components
- Creator
- GitHub artwork library
- GitHub API
Connections 34
- Creator → Workspace shell: uses
README.md - Workspace shell → Auth state: checks identity
src/App.jsx - Auth state → API client: requests session
src/hooks/useAuth.jsx - Workspace shell → Album workspace: shows album
src/App.jsx - Album workspace → API client: loads album data
src/components/AlbumDetail.jsx - Workspace shell → Artwork editor: opens artwork
src/App.jsx - Artwork editor → Canvas controls: renders controls
src/components/ArtworkEditor.jsx - Artwork editor → Drawing grid: renders canvas
src/components/ArtworkEditor.jsx - Artwork editor → API client: saves artwork
src/components/ArtworkEditor.jsx - API client → Express API: sends API requests
- Express API → Runtime configuration: configures runtime
server/src/app.js - Express API → Album routes: mounts routes
server/src/app.js - Album routes → Album API: dispatches albums
server/src/routes/albumRoutes.js - Album routes → Artwork API: dispatches artwork
server/src/routes/albumRoutes.js - Album routes → Story API: dispatches stories
server/src/routes/albumRoutes.js - Album routes → Branch API: dispatches branches
server/src/routes/albumRoutes.js - Album routes → Issues API: dispatches issues
server/src/routes/albumRoutes.js - Album routes → Pull requests API: dispatches pull requests
server/src/routes/albumRoutes.js - Album routes → Album fork API: dispatches forks
server/src/routes/albumRoutes.js - Album API → Album service: delegates album operations
server/src/controllers/albumController.js - Artwork API → Artwork service: delegates artwork operations
server/src/controllers/artworkController.js - Story API → Story service: delegates story operations
server/src/controllers/storyController.js - Branch API → Branch service: delegates branch operations
server/src/controllers/branchController.js - Issues API → Issues service: delegates issue operations
server/src/controllers/issueController.js - Pull requests API → Pull requests service: delegates pull requests
server/src/controllers/pullRequestController.js - Album fork API → Album fork service: delegates forks
server/src/controllers/forkController.js - Album service → GitHub client: makes GitHub requests
server/src/services/albumService.js - GitHub client → GitHub API: calls GitHub
server/src/utils/githubClient.js - GitHub API → GitHub artwork library: reads and writes library
README.md - OAuth API → GitHub auth service: exchanges OAuth code
server/src/controllers/authController.js - OAuth API → Album service: initializes library
server/src/controllers/authController.js - OAuth API → Session cryptography: encrypts session token
server/src/controllers/authController.js - Session middleware → Session cryptography: verifies and decrypts
server/src/middleware/auth.js - OAuth API → GitHub API: performs GitHub OAuth