Home

Awesome

⚠️ We have moved headlesscms.org to jamstack.org/headless-cms/

You can still contribute at https://github.com/jamstack/jamstack.org/ or join us on Slack at http://jamstack.slack.com/


headlesscms.org

headlesscms.org, a leaderboard of top open-source static site content management systems.

Netlify Status

Contributing

Missing a headless CMS here? Just fork the repo and add yours as a <name>.md in the content/projects folder.

Make sure to follow the following rules:

Usage

Be sure that you have the latest node and npm installed, then clone this repository and run:

npm install
npm start

In order to successfully retrieve Twitter followers and GitHub stars, you will need authentication keys for both services.

For GitHub you'll need is a personal access token with permission to create Gists. This can be generated at https://github.com/settings/tokens. For Twitter, you need to create an application at https://apps.twitter.com to get the necessary tokens. When deploying, you must set the environment variables per the example below. If you are developing locally, you can set these in a .env file at the root of the repo.

HEADLESS_CMS_GITHUB_TOKEN=examplekey123abc
HEADLESS_CMS_TWITTER_CONSUMER_KEY=examplekey231abc
HEADLESS_CMS_TWITTER_CONSUMER_SECRET=examplekey321abc
HEADLESS_CMS_TWITTER_ACCESS_TOKEN_KEY=examplekey231abc
HEADLESS_CMS_TWITTER_ACCESS_TOKEN_SECRET=examplekey321abc

GitHub and Twitter data is cached in the .tmp directory, and online in a Gist. If neither has data newer than 24 hours old, fresh data is fetched from GitHub and Twitter. Fetching caching occur automatically during the build.

Then visit http://localhost:3000/ - React Static will automatically reload when changes occur.

To test a production build locally, do:

npm run stage
npm run serve

To run a production build for deployment:

npm run build

Netlify

headlesscms.org is built and maintained by Netlify, a hosting and automation service for static websites and apps.

License

This project is licensed under the MIT license.