## File: README.md [](https://github.com/decaporg/decap-cms/blob/main/LICENSE) [](https://app.netlify.com/sites/decap-www/deploys) [](https://www.npmjs.com/package/decap-cms) [](https://github.com/decaporg/decap-cms/actions?query=branch%3Amain+workflow%3A%22Node+CI%22) [](https://github.com/decaporg/decap-cms/blob/main/CONTRIBUTING.md) A CMS for static site generators. Give teams a simple way to edit and add content to any site built with a static site generator. _Decap CMS is the new name of Netlify CMS [since February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/)._ [Join us on Discord](https://decapcms.org/chat) for community chat. ## How It Works Decap CMS is a single-page app that you pull into the `/admin` part of your site. It presents a clean UI for editing content stored in a Git repository. You setup a YAML config to describe the content model of your site, and typically tweak the main layout of the CMS a bit to fit your own site. When a user navigates to `/admin/` they'll be prompted to log in, and once authenticated they'll be able to create new content or edit existing content. Read more about Decap CMS [Core Concepts](https://www.decapcms.org/docs/intro/). ## Installation and Configuration Decap CMS can be used in two different ways. * A quick and easy install that requires a single HTML file and a configuration file. All CMS JavaScript and CSS are loaded from a CDN. Learn more in the [Quick Start Guide](https://www.decapcms.org/docs/quick-start/). * A complete, more advanced install that gives you more flexibility but requires a static site builder with a build system that supports npm packages. Need centralized user management, advanced roles, a database proxy, or premium support? Explore [Decap Turbo](https://decapcms.org/turbo/). ## Sponsors Help support Decap CMS development by becoming a sponsor! Your contributions help us maintain and improve this open-source project. [](https://github.com/sponsors/decaporg) [](https://opencollective.com/decap) ### Main Partner Decap CMS is supported by our main partner [PM](https://p-m.si/). ### Backers [](https://github.com/Zwyx)  [](https://github.com/smolcodes)  [](https://github.com/shizik)  [](https://github.com/JacquesRaoult)   Thank you for your support! ## Contribute New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/decaporg/decap-cms/blob/main/CONTRIBUTING.md) to get involved. ## Change Log This project adheres to [Semantic Versioning](http://semver.org/). Every release is documented on the GitHub [Releases](https://github.com/decaporg/decap-cms/releases) page. ## License Decap CMS is released under the [MIT License](LICENSE). Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html). ## Expert Services Get hands-on help from Decap experts and partners for onboarding, custom feature development, website development and premium support. [Explore expert services](https://decapcms.org/services/) --- ## File: cypress/utils/README.md ## Utilities for integration tests Utils in this dir must be explicitly included in each spec file, e.g.: ``` import '../utils/dismiss-local-backup'; ``` For routines to be executed on all tests, please use the `cypress/plugins.index.js` file instead: https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html#Plugin-files --- ## File: cypress/Readme.md # Cypress Tests Guide ## Introduction [Cypress](https://www.cypress.io/) is a JavaScript End to End Testing Framework that runs in the browser. Cypress tests run with a [local version](../dev-test) of the CMS. During the setup of a spec file, the relevant `index.html` and `config.yml` are copied from `dev-test/backends/` to `dev-test`. Tests for the `test` backend use mock data generated in `dev-test/backends/test/index.html`. Tests for the other backends use previously [recorded data](fixtures) and stub `fetch` [calls](support/commands.js#L52). See more about recording tests data [here](#recording-tests-data). ## Run Tests Locally ```bash npm run test:e2e # builds the demo site and runs Cypress in headless mode with mock data ``` ## Debug Tests ```bash npm run develop # starts a local dev server with the demo site npm run test:e2e:exec # runs Cypress in non-headless mode with mock data ``` ## Recording Tests Data When recording tests, access to the relevant backend API is required, thus one must set up a `.env` file in the root project directory in the following format: ```bash GITHUB_REPO_OWNER=owner GITHUB_REPO_NAME=repo GITHUB_REPO_TOKEN=tokenWithWritePermissions GITHUB_OPEN_AUTHORING_OWNER=forkOwner GITHUB_OPEN_AUTHORING_TOKEN=tokenWithWritePermissions GITLAB_REPO_OWNER=owner GITLAB_REPO_NAME=repo GITLAB_REPO_TOKEN=tokenWithWritePermissions BITBUCKET_REPO_OWNER=owner BITBUCKET_REPO_NAME=repo BITBUCKET_OUATH_CONSUMER_KEY=ouathConsumerKey BITBUCKET_OUATH_CONSUMER_SECRET=ouathConsumerSecret NETLIFY_API_TOKEN=netlifyApiToken NETLIFY_INSTALLATION_ID=netlifyGitHubInstallationId ``` > The structure of the relevant repo should match the settings in [`config.yml`](../dev-test/backends//config.yml#L1) To start a recording run the following commands: ```bash npm run develop # starts a local dev server with the demo site npm run mock:server:start # starts the recording proxy npm run test:e2e:record-fixtures:dev # runs Cypress in non-headless and pass data through the recording proxy npm run mock:server:stop # stops the recording proxy ``` > During the recorded process a clone of the relevant repo will be created under `.temp` and reset between tests. Recordings are sanitized from any possible sensitive data and [transformed](plugins/common.js#L34) into an easier to process format. To avoid recording all the tests over and over again, a recommended process is to: 1. Mark the specific test as `only` by changing `it("some test...` to `it.only("some test...` for the relevant test. 2. Run the test in recording mode. 3. Exit Cypress and stop the proxy. 4. Run the test normally (with mock data) to verify the recording works. ## Debugging Playback Failures Most common failures are: 1. The [recorded data](utils/mock-server.js#L17) is not [transformed](plugins/common.js#L34) properly (e.g. sanitization broke something). 2. The [stubbed requests and responses](support/commands.js#L82) are not [matched](support/commands.js#L32) properly (e.g. timestamp changes in request body between recording and playback). Dumping all recorded data as is to a file [here](utils/mock-server.js#L24) and adding a `debugger;` statement [here](support/commands.js#L52) is useful to gain insights. Also comparing console log messages between recording and playback is very useful (ordering of requests, etc.) --- ## File: packages/decap-server/README.md # Decap CMS Proxy Server Decap CMS Proxy Server is an express server created to facilitate local development. ## How It Works 1. Navigate to a local Git repository configured with the CMS. 2. Run `npx decap-server` from the root directory of the above repository. 3. Update your `config.yml` to connect to the server: ```yaml backend: name: proxy proxy_url: http://localhost:8081/api/v1 branch: master # optional, defaults to master ``` 4. Start you local development server (e.g. run `gatsby develop`). ## Custom Configuration 1. Create a `.env` file in the root directory of your local Git repository. 2. Update the file as follows: ```bash # optional, defaults to current directory GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO # optional, defaults to 8081 PORT=CUSTOM_PORT # optional, only listen for incoming connections on a specific IP address BIND_HOST=127.0.0.1 # optional, restrict API requests to a specific origin. Default is /^https?:\/\/(localhost|127\.0\.0\.1)(:\d+)?$/ to allow requests from localhost and 127.0.0.1. ORIGIN=https://example.com ``` --- ## File: packages/decap-cms-widget-text/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-text/README.md)! --- ## File: packages/decap-cms-widget-string/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-string/README.md)! --- ## File: packages/decap-cms-widget-select/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-select/README.md)! --- ## File: packages/decap-cms-widget-relation/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-relation/README.md)! --- ## File: packages/decap-cms-widget-object/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-object/README.md)! --- ## File: packages/decap-cms-widget-number/README.md # Docs coming soon! Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages. We haven't created a README for this package yet, but you can: 1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation site](https://www.decapcms.org) for more info. 2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help. 3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-number/README.md)!