https://github.com/thompsonemerson/wordparcel

A simple workflow to development of WordPress with ParcelJS
https://github.com/thompsonemerson/wordparcel

boilerplate bundler development parcel parcel-bundler parceljs wordparcel wordpress wordpress-development wordpress-starter-theme workflow wp

Last synced: about 1 month ago
JSON representation

A simple workflow to development of WordPress with ParcelJS

• Host: GitHub
• URL: https://github.com/thompsonemerson/wordparcel
• Owner: thompsonemerson
• Created: 2020-06-07T19:55:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T15:05:34.000Z (about 2 years ago)
• Last Synced: 2024-11-06T04:30:19.308Z (3 months ago)
• Topics: boilerplate, bundler, development, parcel, parcel-bundler, parceljs, wordparcel, wordpress, wordpress-development, wordpress-starter-theme, workflow, wp
• Language: PHP
• Homepage:
• Size: 173 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



## Getting started

Start to clone the project for your machine in the directory that will work.

```bash

# clone it:

$ git clone https://github.com/thompsonemerson/wordparcel.git

# open the project folder:

$ cd wordparcel

```

### Configuring WordPress

The command below will download and install the latest version of WordPress that will be launched at the url `http://localhost:1234`.

```bash

# use npm:

$ npm run wp:install

# or yarn:

$ yarn wp:install

```

> In this step, note that you will need to fill in the database information. normal WordPress installation process.

### Install dependencies

Install the necessary dependencies and start the development.

```bash

# use npm:

$ npm i

# or yarn:

$ yarn

```

> Ready!!! 🎉 
 there should now be a directory called `wordparcel` that was automatically taken to the WordPress themes area (`wordpress/wp-content/themes`).

### Run project

Both commands will execute at the url `http://localhost:1234`.

#### Serve and watch

```bash

# use npm:

$ npm run dev

# or yarn:

$ yarn dev

```

#### Only serve

```bash

# use npm:

$ npm start

# or yarn:

$ yarn start

```

## Structure

```

├── scripts.sh

├── package.json

├── README.md

├── wordpress [created after wp:install]

├── plugins [to version WordPress plugins]

└── src

    ├── js

    │   ├── scripts.js [required]

    │   └── *.js

    │

    ├── images

    │   └── {.jpg, .png, .svg, .gif, .ico}

    │

    ├── scss

    │   ├── styles.scss [required]

    │   └── *.scss

    │

    ├── footer.php

    ├── functions.php

    ├── header.php

    ├── index.php

    └── style.css

```

> Note that in the structure only the `scripts.js` and `styles.scss` files are required for the bundler, and the wordpress folder is created automatically after the `wp:install` command.