@campj/preview

1.0.3 • Public • Published

@campj/preview

  • Quickly create & configure a Heroku app that will provide a live preview for DatoCMS
  • Creates a _redirects file in the 'static' folder
  • Creates a Procfile that instructs Heroku on how to run the app
  • Creates a netlify.toml with DATO_API_TOKEN (move to @campj/dato ????)

Options

Key Type Default Value Details
herokuAppName String Can't contain spaces or capital letters
If ommitted, terminal will prompt user for a name
previewSlug String 'preview' Used to redirect to the Heroku app
datoAPIToken String process.env.DATO_API_TOKEN Required if DATO_API_TOKEN is not defined in .env file

Important Note

  • After this plugins runs, be sure to commit. Then, run git push heroku master to deploy.
  • A Procfile is created when you first start your site after configuring this theme in your plugins. To prevent the creation of a new Heroku app every time you start your site, make sure you do NOT delete the Procfile.

NEED TO DO:

  • add env vars to root netlify.toml if 'site' and 'studio' are in the same repo (otherwise netlify build won't work)

Readme

Keywords

none

Package Sidebar

Install

npm i @campj/preview

Weekly Downloads

1

Version

1.0.3

License

MIT

Unpacked Size

10.3 kB

Total Files

5

Last publish

Collaborators

  • camp-jefferson-dev