Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.56 KB

Contributing

Thank you for your interest in contributing to this project! ❤️

Installation

Requirements: node v16 or newer.

Set up Ghost

Follow the official Ghost setup guide to install Ghost locally on your machine.

Clone and Activate the Theme

  1. Clone the theme into the <YOUR_GHOST_INSTALLATION>/content/themes directory. Optionally clone the theme to a place of your choice and create a symlink in the said destination. Either way you should end up with this structure: <YOUR_GHOST_INSTALLATION>/content/themes/frontend-garden-ghost-theme.

  2. In the theme root run:

    npm install
    npm run build
  3. In the Ghost installation directory run ghost start.

  4. Visit http://localhost:2368 in your browser.

  5. Activate frontend-garden-ghost-theme on the Design administration page. ⚠️ Do not try to re-upload the theme. If you followed step 1 it's already there!

  6. In the theme root there is a routes.yaml file. Upload this single file using Routes on the Labs administration page.

  7. Congrats, you're done! 🎉

Development with Live Reload

Install nodemon globally on your machine:

npm install --global nodemon

Run nodemon in the Ghost app directory:

nodemon current/index.js --watch content/themes/frontend-garden-ghost-theme --ext hbs,js,css

Start watching for changes in the frontend-garden-ghost-theme directory:

npm start