Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netlify/headlesscms.org
Source for headlesscms.org
https://github.com/netlify/headlesscms.org
headless-cms jamstack netlify static-site static-site-generator
Last synced: about 2 months ago
JSON representation
Source for headlesscms.org
- Host: GitHub
- URL: https://github.com/netlify/headlesscms.org
- Owner: netlify
- License: mit
- Archived: true
- Created: 2017-01-05T19:14:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T17:34:08.000Z (about 4 years ago)
- Last Synced: 2024-09-25T18:49:35.601Z (about 2 months ago)
- Topics: headless-cms, jamstack, netlify, static-site, static-site-generator
- Language: JavaScript
- Homepage: https://headlesscms.org/
- Size: 36.5 MB
- Stars: 625
- Watchers: 45
- Forks: 150
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - headlesscms.org - Source for headlesscms.org (JavaScript)
README
## ⚠️ We have moved headlesscms.org to [jamstack.org/headless-cms/](https://www.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](http://www.headlesscms.org), a leaderboard of top open-source static site content management systems.
[](https://app.netlify.com/sites/headlesscms/deploys)
## Contributing
Missing a headless CMS here? Just fork the repo and add yours as a `.md` in the
`content/projects` folder.
Make sure to follow the following rules:
* **Truly headless:** This means your CMS must interact with content and data, and cannot be responsible for building the site.
* **Jamstack:** Your CMS has to work with the Jamstack methodology: JavaScript, API's and Markup.
* **Stick to the format:** Fill out all the same fields as the other CMS's in `content/projects`.
* **Short description:** Keep all the details for the body text, keep the description for the overview page short and sweet.
## Usage
Be sure that you have the latest node and npm installed, then clone this repository and run:
```bash
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
. For Twitter, you need to create an application at
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:
```bash
npm run stage
npm run serve
```
To run a production build for deployment:
```bash
npm run build
```
## Netlify
headlesscms.org is built and maintained by [Netlify](https://www.netlify.com), a hosting and automation service for static websites and apps.
## License
This project is licensed under the [MIT license](http://opensource.org/licenses/MIT).