silverstripe / silverstripe/developer-docs

Tutorial series for PWA with GraphQL

Open
#36 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v4 complexity/high impact/high type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

Overview

  • As a developer new to SilverStripe, I want to get a quick overview on building solutions on a decoupled CMS in order to evaluate the products suitability for modern applications
  • As a developer with existing SilverStripe experience, I want to apply my existing knowledge to building solutions on a decoupled CMS in order to stay relevant in a changing market

Acceptance Criteria

  • Uses React (since that's our stack of choice)
  • Popularises the JAMStack use case
  • Uses aspects of a Progressive Web App (e.g. manifest)
  • Minimises documentation around third party tools (e.g. Apollo)
  • Final code can be browsed quickly for devs who know parts of the solution already
  • Does not render data through SSViewer
  • Frontend implementation is maintainable (minimises duplication between simple theme, watea theme, and potential new demo theme)

Notes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked demo app and the existing developer documentation to understand the proposed React and GraphQL flow. Resolve the Staticpublishqueue-versus-Gatsby question and define the tutorial steps before implementation; done means a browsable tutorial series covering the listed PWA, JAMStack, decoupled CMS, and maintainability criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, react
Domain
documentation, frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.