Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Latest commit

 

History

History
96 lines (59 loc) · 3.77 KB

README.md

File metadata and controls

96 lines (59 loc) · 3.77 KB
Raw

GatherContent Headless CMS Example

This repository is set-up to work with a GatherContent example project, publishing content to Vercel or Netlify, which then uses Next.js to present on the front end. You can adapt this to pull content from any of your projects, and see how quick you can build out websites and other experiences on top of GatherContent.

Prerequisites

  • A GatherContent account.

  • An example project called "Course records (headless CMS example)". If you don't have this, contact us, and we'll add it to your account.

  • An API Key (follow these instructions to find your API key).

  • The project id for the example project. Every account should have this project, and you can find the id in the project settings.

Deploying

To deploy with Vercel, click:

Deploy with Vercel

To deploy with Netlify, click:

Deploy with Vercel

Required environment variables

GATHERCONTENT_API_USERNAME=<email>
GATHERCONTENT_API_KEY=<api-key>
GATHERCONTENT_PROJECT_ID=<project-id>

  • GATHERCONTENT_API_USERNAME (is your email address which you used to sign up to GatherContent)

  • GATHERCONTENT_API_KEY

  • GATHERCONTENT_PROJECT_ID

As every project is unique, you'll need some environment variables for getting your content;

CONTENT_HERO_IMAGE_FIELD_UUID=<uuid-of-hero-image-field>
CONTENT_HOURS_FIELD_UUID=<uuid-of-hours-field>
CONTENT_WEEKS_FIELD_UUID=<uuid-of-weeks-field>
CONTENT_CREDITS_FIELD_UUID=<uuid-of-credits-field>

Discovering these can be tricky, so we built a tool to help you generate the .env file automatically. You can run the following command (you'll need your email, api key and project id);

yarn && yarn env --email=<email> --apiKey=<api-key> --projectId=<projectId>

After this is complete you should see the required details to run your project locally. You can also use these details when deploying your site to Vercel or Netlify.

Local development

To run the project locally, you need to fork this repo or clone it. As well as having node & yarn installed.

git clone [email protected]:gathercontent/nextjs-site-example.git

Next, install all dependencies:

yarn

Manually create an .env file and enter all the required environment variables Use .env.example as a starter if you wish.

touch .env

or, you can generate the env file using (if you've already done this, then don't worry);

yarn env --email=<email> --apiKey=<api-key> --projectId=<projectId>

Finally, you can start development server;

yarn dev

Be sure to navigate to http://localhost:3000 to see your example project locally.

Local caching

To help speed up local development we've implemented memory-cache to store data locally instead of fetching for every route change.

This heavily speeds up navigation. To break the cache and fetch the most recent content from the API, you can re-run yarn dev and refresh the page.

You may experience slower speeds on the first visit to a page, but any visits after that will be a lot faster.