Awesome
next-cms-ghost
The fastest React frontend for headless Ghost CMS.
Create and publish flaring fast blogs with <i>next-cms-ghost</i>. Powered by the React framework Next.js and content fed by headless Ghost, you'll get a production ready hybrid frontend that combines the best of static and server-rendered sites. Most importantly, your website can be easily distributed globally to be served from the edge. At the same time your content creators can continue to work with the Ghost authoring system they are used to.
✨ Features
<details> <summary>Ghost CMS integration</summary> <br /> <ul> <li>Supports Ghost `v3` and `v4`</li> </ul> </details> <details> <summary>Ghost Casper look & feel</summary> <br /> <ul> <li>Infinite scroll</li> <li>Fully responsive</li> <li>Sticky navigation headers</li> <li>Hover on author avatar</li> <li>Styled 404 page</li> <li>Preview Section in posts</li> <li>Sitemap</li> <li>RSS feed</li> <li>SEO optimized</li> </ul> </details> <details> <summary>Extened Casper Styles ✨</summary> <br /> <ul> <li>Dark Mode</li> <li>Featured posts pinned on top</li> <li>Customizable navigation headers</li> <li>Zoom images on click to full-screen</li> <li>Render GitHub Gists</li> </ul> </details> <details> <summary>Images with Next/Images 🚀</summary> <br /> <ul> <li>Feature and inline images</li> <li>Auto-optimized images</li> <li>No content shifts due to consistent placeholders</li> </ul> </details> <details> <summary>Advanced Routing</summary> <br /> <ul> <li>Auto-detects custom paths</li> <li>Configurable collections</li> </ul> </details> <details> <summary>Developer friendly</summary> <br /> <ul> <li>MIT licenced</li> <li>Truly open-source</li> <li>Easy to contribute</li> <li>Made typesafe with TypeScript</li> </ul> </details> <details> <summary>Integrated Plugins</summary> <br /> <ul> <li>Member Subscriptions</li> <li>Commenting with Commento or Disqus</li> <li>Syntax highlighting with PrismJS</li> <li>Table Of Contents</li> <li>Contact Page with built-in notification service</li> <li>Google Analytics</li> </ul> </details> <details> <summary>NextJS Features</summary> <br /> <ul> <li>Incremental Regeneration</li> <li>Support for Preview</li> </ul> </details>
🚀 Performance
<sup>Scores calculated with Lighthouse 6.4.0.</sup>
🏁 Getting Started
git clone https://github.com/styxlab/next-cms-ghost.git
cd next-cms-ghost
yarn
# Development
yarn dev
# Production
yarn build
🌀 NextJS image optimizations
The IMAGE_DOMAINS environment variable must contain a comma separated list of all domains that you use for in-sourcing images. For example:
IMAGE_DOMAINS=res.cloudinary.com,yoursource.imgix.net
Image optimization is automatically turned off when deploying to Netlify, because it is currently on supported on Netlify.
🌎 Domain Settings
The SITE_URL environment variable should be set to the public facing URL of your site, in most cases to your custom domain.
| Key | Value (example) |
|---|---|
| SITE_URL | https://www.your-blog.org |
If you don't specify SITE_URL, it will get populated according to the following defaults:
| Platform | System Value | Conditions |
|---|---|---|
| Vercel | VERCEL_URL | Automatically expose System Environment Variables must be checked |
| Netlify | URL |
In all other cases SITE_URL is set to http://localhost:3000.
🔑 Ghost Content API keys
All content is sourced from a Ghost CMS. Choose the method according to your build scenario.
Building locally
Create a new text file .env.local in the project root folder with the following content:
CMS_GHOST_API_URL=http://localhost:2368
CMS_GHOST_API_KEY=9fccdb0e4ea5b572e2e5b92942
Change CMS_GHOST_API_URL and CMS_GHOST_API_KEY with the values that you can generate in your Ghost Admin under Integrations.
Building with cloud providers
If you build your project with a cloud provider, the best option is to provide the keys with environment variables:
| Key | Value (example) |
|---|---|
| CMS_GHOST_API_URL | https://your-ghost-cms.org |
| CMS_GHOST_API_KEY | 9fccdb0e4ea5b572e2e5b92942 |
💫 Deploy
For best results, deploying to Vercel is recommended. As an alternative, you can also deploy to Netlify.
🤯 Ensure headless mode of Ghost CMS
For best SEO results it is strongly recommended to disable the default Ghost Handlebars theme front-end by selecting the Make this site private flag within your Ghost admin settings.
💣 Reporting issues
Please report all bugs and issues at next-cms-ghost/issues.
🎈 Contributions
PRs are welcome! Consider contributing to this project if you want to make a better web.
Special thanks goes to these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/weisisheng"><img src="https://avatars1.githubusercontent.com/u/47701145?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vince Fulco</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=weisisheng" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/BeatPlus"><img src="https://avatars3.githubusercontent.com/u/2022256?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Manuel Taberna</b></sub></a><br /><a href="#translation-BeatPlus" title="Translation">🌍</a></td> <td align="center"><a href="https://akshatmittal.com"><img src="https://avatars1.githubusercontent.com/u/1667481?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Akshat Mittal</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=akshatmittal" title="Code">💻</a></td> <td align="center"><a href="https://github.com/christianlauer"><img src="https://avatars0.githubusercontent.com/u/65625616?v=4?s=100" width="100px;" alt=""/><br /><sub><b>christianlauer</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Achristianlauer" title="Bug reports">🐛</a></td> <td align="center"><a href="https://linkedin.com/in/rahulsuresh98"><img src="https://avatars2.githubusercontent.com/u/22114682?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rahul Suresh</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Aicy-meteor" title="Bug reports">🐛</a></td> <td align="center"><a href="https://blog.miguelbernard.com"><img src="https://avatars.githubusercontent.com/u/1928530?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Miguel Bernard</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=mbernard" title="Code">💻</a></td> <td align="center"><a href="https://github.com/marsflow"><img src="https://avatars.githubusercontent.com/u/7637037?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stevan Aji</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=marsflow" title="Code">💻</a></td> </tr> <tr> <td align="center"><a href="https://github.com/imtoanle"><img src="https://avatars.githubusercontent.com/u/4002252?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Toan Le</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Aimtoanle" title="Bug reports">🐛</a></td> <td align="center"><a href="http://davor.pro"><img src="https://avatars.githubusercontent.com/u/1422662?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Davor Budimir</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3ABuda9" title="Bug reports">🐛</a></td> <td align="center"><a href="https://simonholdorf.com"><img src="https://avatars.githubusercontent.com/u/4987937?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simon Holdorf</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Asimhol" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/timuster"><img src="https://avatars.githubusercontent.com/u/2242052?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sumit Kumar</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Atimuster" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/francolamcn"><img src="https://avatars.githubusercontent.com/u/73523739?v=4?s=100" width="100px;" alt=""/><br /><sub><b>francolamcn</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Afrancolamcn" title="Bug reports">🐛</a></td> <td align="center"><a href="https://www.ambrosesoft.com/"><img src="https://avatars.githubusercontent.com/u/60314?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Chan</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=chancharles" title="Code">💻</a></td> <td align="center"><a href="https://raihanameen.github.io"><img src="https://avatars.githubusercontent.com/u/36153203?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Raihan Ameen</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Araihanameen" title="Bug reports">🐛</a></td> </tr> <tr> <td align="center"><a href="http://andygrunwald.com/"><img src="https://avatars.githubusercontent.com/u/320064?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andy Grunwald</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=andygrunwald" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/seoxyz"><img src="https://avatars.githubusercontent.com/u/54107458?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hikz</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=seoxyz" title="Code">💻</a></td> <td align="center"><a href="https://huydhoang.com"><img src="https://avatars.githubusercontent.com/u/8493044?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Huy</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/issues?q=author%3Ahuydhoang" title="Bug reports">🐛</a></td> <td align="center"><a href="https://meyer-laurent.com"><img src="https://avatars.githubusercontent.com/u/94935904?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Laurent Meyer</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=laurentmmeyer" title="Code">💻</a></td> <td align="center"><a href="https://prettyfrenchgames.com/"><img src="https://avatars.githubusercontent.com/u/10576004?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Garfounkel</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=Garfounkel" title="Code">💻</a></td> <td align="center"><a href="http://www.dassiorleando.xyz"><img src="https://avatars.githubusercontent.com/u/7150752?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Orleando Dassi</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=dassiorleando" title="Code">💻</a></td> <td align="center"><a href="https://github.com/flaviolivolsi"><img src="https://avatars.githubusercontent.com/u/5151628?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Flavio Li Volsi</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=flaviolivolsi" title="Code">💻</a></td> </tr> <tr> <td align="center"><a href="https://github.com/nring"><img src="https://avatars.githubusercontent.com/u/801071?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nat Ring</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=nring" title="Code">💻</a></td> <td align="center"><a href="https://github.com/vitoropereira"><img src="https://avatars.githubusercontent.com/u/47868559?v=4?s=100" width="100px;" alt=""/><br /><sub><b>VITOR PEREIRA</b></sub></a><br /><a href="https://github.com/styxlab/next-cms-ghost/commits?author=vitoropereira" title="Code">💻</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!
🧐 Disclaimer
This project is not affiliated with NextJS or Ghost.
Copyright & License
Copyright (c) 2020 - 2021 styxlab - Released under the MIT license.