Prezly Heartbeat theme is our internal newsroom used to share information and updates with the team. It is powered by the Prezly starter theme and thus running on Next.js.
To style the newsroom we're using TailwindCSS with the new Just-In-Time compiler.
The newsroom is running within our own infrastructure and guarded by admin login/password combo.
- 🎈 Homepage with list of articles
- 🤖 Optional commenting using discourse
- 📖 Article detail including images, galleries, cards and video
- 🔥 Next.js with SSR, SSI or SSG option
- 💨 TailwindCSS and the new Just-In-Time compiler
- 🧪 Test/Seed data in 3 categories
- 🎉 Type checking TypeScript
- 🎨 Strongly typed content/entities
- ☕ Minify HTML & CSS
- 💨 Live reload/Fast refresh
- ✅ Code splitting and bundling
- ☯ Hybrid: SSG, SSI or SSR
- 🌄 Image optimization
- Node.js and npm
Run the following command on your local environment
git clone https://github.com/prezly/theme-nextjs-heartbeat.git
cd theme-nextjs-heartbeat
npm i
Set up your .env.local file by copying .env.example and filling in Prezly API key and newsroom UUID.
cp .env.example .env.local
After that you can run locally in development mode with live reload:
npm run dev
Open http://localhost:3000 with your favorite browser to see your project.
Deploy the example using Vercel or Netlify:
| Vercel | Netlify |
|---|---|
 |
To encourage Prezlians to share/talk/comment on company news every story detail has a link to a discourse comment thread. The way this works:
- every time you visit a heartbeat story we check if a topic with same title exists in discourse
- if not, we create a topic, with all the story details (converted to html)
- under every Prezly story there is now a link with comments/conversation around that heartbeat post
To enable this set up your discourse API host, API secret, username and category ID.
List of routes we automatically generate:
- / : Index page listing stories
- /[article_slug] : Article pages with slug provided by PrezlySDK
- /category/[category:slug] : Category page listing articles in respective category
- /sitemap.xml: Sitemap
To ease with development we have created a few sample newsrooms in different categories:
- The Good Newsroom: A newsroom filled with good news
- Cookbook: Recipes shared by the Prezly team
- Anonymous Photographer: Pictures from a photographer. Combination of albums and imagery
A list of tokens/newsroom uuids that can be used to kickstart the theme.
| Name | API Token | Newsroom UUID |
|---|---|---|
| Good Newsroom | HKcab_nEbab_a7b2fe3a3465d3729772fa5381800ab5a0c30d8d |
578e78e9-9a5b-44ad-bda2-5214895ee036 |
| Cookbook | TKcab_nEbab_28432b75d3a85a826e51cd0b502a3d76acf98d19 |
9d90b2c1-aed9-4415-a9fb-82dd3a2a1b52 |
| Anonymous Photographer | SKcab_nEbab_0b63a6dd0b09286cc99fab93e6e80bfd9aecfbb5 |
ce8299f6-a293-41df-8ffc-1c064d4401bc |
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.
Licensed under the GNU GENERAL PUBLIC LICENSE, Copyright © 2021
See LICENSE for more information.
Made with ♥ by Prezly.com