diff --git a/README.md b/README.md index 7838a71..b5107db 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ - GraphQL endpoint - Multilanguage support - Markdown format for the rich text fields + - Use webhooks to notify the front-end of updates #### [Image Processor](https://github.com/Accords-Library/img.accords-library.com) @@ -29,6 +30,7 @@ - The operations are stored in a graphql file and then retrieved and wrap as an actual TypeScript function - Markdown: [markdown-to-jsx](https://www.npmjs.com/package/markdown-to-jsx) - Support for Arbitrary React Components and Component Props! + - Autogenerated multi-level table of content and anchor links for the different headers - Styling: [Tailwind CSS](https://tailwindcss.com/) - Good typographic defaults using [Tailwind/Typography](https://tailwindcss.com/docs/typography-plugin) - Beside the theme declaration no CSS outside of Tailwind CSS @@ -36,17 +38,19 @@ - Support for [Material Icons](https://fonts.google.com/icons) - Support for light and dark mode with a manual switch and system's selected theme by default - Support for creating any arbitrary theming mode by swapping CSS variables + - Support for many screen sizes and resolutions - Framework: [Next.js](https://nextjs.org/) (React) - Multilanguage support - State Management: [React Context](https://reactjs.org/docs/context.html) - Persistent app state using LocalStorage -- Support for many screen sizes and resolutions -- SSG (Static Site Generation): +- SSG + ISR (Static Site Generation + Incremental Static Regeneration): - The website is built before running in production - Performances are great, and possibility to deploy the app using a CDN -- OpenGraph and Metadata + - On-Demand ISR to continuously update the website when new content is added or existing content is modified/deleted. +- SEO - Good defaults for the metadate and OpenGraph properties - Each page can provide the thumbnail, title, description to be used + - Automatic generation of the sitemap using [next-sitemap](https://www.npmjs.com/package/next-sitemap) - Data quality testing - Data from the CMS is subject to a battery of tests (about 20 warning types and 40 error types) at build time - Each warning/error comes with a front-end link to the incriminating element, as well as a link to the CMS to fix it. @@ -70,7 +74,8 @@ Enter the followind information: ```txt URL_GRAPHQL=https://url-to.strapi-accords-library.com/graphql -ACCESS_TOKEN=genatedcode-by-strapi-api +ACCESS_TOKEN=abcdef0123456789 +REVALIDATION_TOKEN=abcdef0123456789 SMTP_HOST=email.provider.com SMTP_USER=email@example.com SMTP_PASSWORD=mypassword123