Skip to content
This repository has been archived by the owner on Feb 5, 2023. It is now read-only.

Commit

Permalink
Updated the theme development section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
natedillon committed Jun 24, 2022
1 parent 527b645 commit 1eae8e5
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,20 @@ Commit any changes to the repository (including the `composer.lock` file).

**Note:** When updating Drupal, the update command should be run locally, tested, then deployed to the server. Once the changes are deployed, the `composer install` command can be run on the server in order to update the installation. Running the the `composer update` command directly on the server may cause excessive resource usage.

## Theme Development
## Theme development

For theme development, you must have [npm](https://www.npmjs.com/) and [Grunt](https://gruntjs.com/) installed in order to build the static files.
For theme development, you must have [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) installed in order to build the static files.

Once the requirements are installed, navigate to the `web/themes/custom/tallgrasschurch` directory and install the npm requirements:
Navigate to the `web/themes/custom/tallgrasschurch` directory, and run the `nvm use` command to switch to the project version of [Node.js](https://nodejs.org/) (installing Node.js if needed). Install the npm requirements with the `npm install` command.

```
npm install
```

**Note:** Edit CSS and JavaScript files from the `src` directory. Files in the `css` and `js` directories will be overwritten on build.
**Note:** Edit Sass and JavaScript files from the `src` directory. Files in the `css` and `js` directories will be overwritten on build.

### Grunt Commands
### npm commands

#### `grunt`
#### `npm start`

The default command, which runs `grunt serve`.
Builds the static files and watches for changes.

#### `grunt build`
#### `npm build`

Builds the static files.

#### `grunt serve`

Runs `grunt build` and then watches for changes.

0 comments on commit 1eae8e5

Please sign in to comment.