How francisauwerda/home-workouts-backend works
Project type and purpose
• This is a Node.js “backend” service implementing a GraphQL API for a home‐workouts web application.
• Its sole purpose is to serve “workouts” and “exercises” data to a front-end client via GraphQL queries and mutations.
File structure
Top-level:
• server.js ← entry point, starts the HTTP/GraphQL server
• package.json, .gitignore, LICENSE, README.md
• storage/ ← file or media storage helper
server/:
• db/ ← database connection initialization
• models/ ← ORM or data‐access layer (Exercise, Workout)
• requestHandlers/ ← resolver implementations for GraphQL operations
• schema/ ← GraphQL type definitions, root query, mutations
• scripts/ ← CLI scripts to seed/refresh the database
Key insights from README
• Minimal description: “This will serve workouts and exercises to my web app.”
• Implies a classic full-stack architecture with clear backend responsibilities.
Components
a. External Client (Web App)
• Sends GraphQL HTTP requests (queries & mutations)
b. API Layer (server.js + Express/Apollo)
• HTTP server listens on port X
• GraphQL endpoint (/graphql)
c. GraphQL Schema
• Types: ExerciseType, WorkoutType
• RootQueryType for fetch operations
• Mutations for create/update/delete
d. Resolvers (Request Handlers)
• workout.js: implements resolve functions for workout schema
• exercise.js: resolves exercise-related queries/mutations
e. Data-Access Layer
• Models (server/models/*.js)
• Workout and Exercise classes or Sequelize models
• DB connection (server/db/index.js)
f. Persistent Storage
• storage/index.js for file storage or other media, if applicable
g. Auxiliary Scripts
• BulkAddWorkoutAndExercises.js, createExercise.js, etc.—can be a side component or annotated as “CLI scripts for seeding and maintenance”
Relationships and Data Flows
• Client → HTTP POST to /graphql → API Layer
• API Layer → GraphQL Schema → appropriate resolver
• Resolver → Model → DB (CRUD)
• Model → returns data → Resolver → GraphQL layer → API Layer → HTTP response → Client
Architectural Patterns and Design Principles
• Layered architecture: Presentation (HTTP/GraphQL), Domain (Schema + Resolvers), Data (Models + DB)
• GraphQL pattern of schema + resolver separation
• Clearly delineate “scripts” as offline processes, not part of the request flow
Technologies, Frameworks, Libraries
• Node.js runtime
• Express (or Apollo Server) for HTTP and GraphQL
• GraphQL.js or Apollo Server for schema and resolvers
• ORM (e.g., Sequelize or similar) for models
• Relational DB (PostgreSQL, SQLite, etc.)
• Custom file‐storage module in storage/
[ ] External client
[ ] HTTP entry point (/graphql)
[ ] Schema layer (types, queries, mutations)
[ ] Resolver layer (requestHandlers)
[ ] Model/ORM layer (server/models)