Skip to content

04. Setup local environment

Christian Wick edited this page Mar 4, 2021 · 1 revision
  1. Clone this repo

    git clone https://github.com/SettleForDevelopers/Developer-Docs.git

  2. Navigate into your newly created Settle API docs directory

    cd settle-api-docs

  3. Install dependencies

    yarn install

  4. Start the local dev server

    yarn docs:dev

    By default, you should now see your scaffolded Settle APIs docs site at https://localhost:8080🚀

  5. Start the local CMS server

    npx netlify-cms-proxy-server

    Open http://localhost:8080/admin/ to verify that your can administer your content locally. If the default port (8081) is in use, the proxy server won't start and you will see an error message. In this case, follow these steps before proceeding.

    Note: netlify-cms-proxy-server runs an unauthenticated express server. As any client can send requests to the server, it should only be used for local development.