How benikk/chalk works
Chalk is a campus writing community: people create accounts, publish labeled posts, discover and interact with posts, and manage profiles and follows. The browser’s shared API client sends JSON requests to the Express application, whose routes dispatch to controllers and persistence. The README documents additional profile themes, moderation, and account recovery; sampled source confirms the auth and post paths, while several other feature links are documented rather than verified in page code.
Main entry points: users.js User records · auth.js Account workflows · api.js API client · posts.js Post records
Components 23
Website client
- Chalk website
public/js/pages - API client
public/js/api.js - Post interactions
public/js/render.js - Profile experience
public/js/pages/profile.js - Profile themes
public/js/themes.js
API and domain
- Express application
server/app.js - Account routes
server/routes/auth.js - Post routes
server/routes/posts.js - Post workflows
server/controllers/posts.js - Comment workflows
server/controllers/comments.js
Accounts and profiles
- Account workflows
server/controllers/auth.js - People workflows
server/controllers/users.js - Account settings
server/controllers/me.js - Moderation
server/controllers/admin.js
Persistence and services
- User records
server/models/users.js - Post records
server/models/posts.js - Social records
server/models - PostgreSQL database
- Email delivery
server/services/email.js - Photo storage
server/services/photos.js
Other components
- Community members
- Email provider
- Photo provider
Connections 28
- Community members → Chalk website: uses
README.md - Chalk website → API client: requests through
README.md - API client → Express application: calls JSON API
README.md - Post interactions → API client: post actions
- Profile experience → API client: profile actions
public/js/pages/profile.js - Profile experience → Profile themes: applies
public/js/pages/profile.js - Express application → Account routes: mounts
server/app.js - Express application → Post routes: mounts
server/app.js - Account routes → Account workflows: dispatches
server/routes/auth.js - Post routes → Post workflows: dispatches
server/routes/posts.js - Post routes → Comment workflows: dispatches
server/routes/posts.js - Account workflows → User records: reads and writes
server/controllers/auth.js - Account workflows → Social records: uses token records
server/controllers/auth.js - Account workflows → Email delivery: sends account email
server/controllers/auth.js - Email delivery → Email provider: delivers through
- Post workflows → Post records: reads and writes
server/controllers/posts.js - Post workflows → Social records: uses social records
server/controllers/posts.js - Comment workflows → Social records: uses comment records
server/controllers/comments.js - Comment workflows → Post records: checks posts
server/controllers/comments.js - People workflows → User records: reads profiles
server/controllers/users.js - People workflows → Post records: loads user posts
server/controllers/users.js - Account settings → User records: updates account
- Account settings → Photo storage: manages avatar
- Photo storage → Photo provider: stores photos
- Moderation → User records: manages roles
- User records → PostgreSQL database: queries
server/models/users.js - Post records → PostgreSQL database: queries
server/models/posts.js - Social records → PostgreSQL database: queries