Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.84 KB
Raw

How to contribute to Next.js for Acquia CMS

  1. Have Acquia CMS installed from https://github.com/acquia/next-acms/blob/main/README.md#installation-acquia-cms with your Node environment variables copied to your clipboard.

    NOTE: You can use any multi-threaded web server of your choice (i.e. the built-in PHP server isn't supported).

Screenshot of environment variables example on ACMS

  1. Fork the acquia/next-acms project repo and pull it down to your local machine (outside of the ACMS directory is recommended) and add the original repo as the upstream.
$ cd next-acms
$ git remote add upstream https://github.com/acquia/next-acms

  1. Create an .env.local file in the /starters/basic-starter directory in your forked repo and paste in your environment variables from step 1.

  2. From the root directory, run yarn install then yarn dev to start the development server on http://localhost:3000.

    To run in production mode, run yarn preview inside the starters/basic-starter directory.

  3. Now you can make changes to your repo, commit them, push them up to your remote, then create a pull request for acquia/next-acms to contribute.

How to debug with Chrome DevTools

The following approach is with Chrome. For debugging using the VS Code debugger please see: https://nextjs.org/docs/advanced-features/debugging

Running yarn dev will also run NODE_OPTIONS='--inspect' which will allow you to debug server-side Next.js, and it can be accessed by visiting chrome://inspect/#devices in Chrome.

Screenshot of chrome inspect

Click the inspect link at the end of file path at the end of the page, and it will open up a DevTools window. From there, you can click the Sources tab, hit Ctrl+P on Windows/Linux or ⌘+P on macOS to navigate to the file you want to debug.