Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jjpeleato/wp-starter-boilerplate
WordPress base repository for any project.
https://github.com/jjpeleato/wp-starter-boilerplate
php wordpress
Last synced: 2 days ago
JSON representation
WordPress base repository for any project.
- Host: GitHub
- URL: https://github.com/jjpeleato/wp-starter-boilerplate
- Owner: jjpeleato
- License: gpl-2.0
- Created: 2019-02-15T19:36:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T13:59:15.000Z (about 1 month ago)
- Last Synced: 2025-01-19T03:28:33.086Z (10 days ago)
- Topics: php, wordpress
- Language: PHP
- Homepage:
- Size: 207 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress: Starter boilerplate
WordPress base repository for any project.
## Environment
- LOCAL: ~
- LOCAL ADMIN: ~
- DEV: ~
- DEV ADMIN: ~
- PRE: ~
- PRE ADMIN: ~
- PRO: ~
- PRO ADMIN: ~
## Project
Built with WordPress platform using the following technologies: HTML 5, JavaScript, jQuery, CSS3, SASS, Lando (Docker), NPM or Yarn, Gulp v.4 and Deployer.
For your projects I recommend underscores theme. More information about:
- Website: https://underscores.me/
- Theme: https://github.com/automattic/_s
**Note:** You can install the WooCommerce boilerplate and not sassify if it is ecommerce.
### Installing dependencies
- You have to install **Lando**: https://docs.devwithlando.io/
If Lando's tools does not work for you, there is another way. You must install the environment manually: XAMP, Composer, Node.JS, NPM or Yarn and Gulp CLI.
For more information visit:
- XAMP: https://www.apachefriends.org/es/index.html
- Composer: https://getcomposer.org/
- Node and NPM: https://nodejs.org/es/
- Yarn: https://yarnpkg.com/es-ES/
- Gulp: https://gulpjs.com/
**Note:** If you work with Windows < 10. To execute the commands, we recommend installing **Cygwin** http://www.cygwin.com/
**Note:** If you work with Windows 10. To execute the commands, we recommend installing **WSL 2** with Ubuntu https://docs.microsoft.com/es-es/windows/wsl/install-win10
**Note:** If you work with Windows 10. You need install the following package: https://www.npmjs.com/package/win-node-env
**Note:** I recommend installing the following IDE for PHP Programming: Visual Studio Code (https://code.visualstudio.com/) or PHPStorm (recommended) (https://www.jetbrains.com/phpstorm/).
### Project skeleton
```
├─ .husky/ # Husky directory (git-hooks)
├─ assets/ # Front-end directory
│ ├─ acf/
│ ├─ fonts/
│ ├─ img/
│ ├─ js/
│ ├─ scss/
│ ├─ .htaccess.dist
│ └─ .htpasswd.dist
├─ gulp/
│ ├─ task/
│ └─ config.js # Paths and configuration Gulp system.
├─ private/
├─ public/ # WordPress directory
├─ .babelrc
├─ .editorconfig
├─ .env.dist
├─ .gitignore
├─ .jshintignore
├─ .jshintrc
├─ .lando.yml
├─ .stylelintignore
├─ .stylelintrc
├─ commitlint.config.js
├─ composer.json
├─ deploy.php
├─ deploy.sh
├─ deploy-exclude-list.txt
├─ gulpfile.babel.js
├─ LICENSE
├─ package.json
├─ phpcs.xml
├─ README.md
└─ validate.sh
```
### Installing
1. Open the `README.md` and rename the name of client, name of project and description.
2. Open the `lando.yml` and rename the project and proxy name.
3. If required.
- Download and install the main theme. Recommended: https://underscores.me/
4. Add the following path `public/wp-content/themes/[theme]/assets` into `.gitignore` file.
5. Open the `gulp/config.js` and rename the `theme` const according theme path.
6. Copy the `public/wp-config-sample.php` to `public/wp-config.php`.
- Add the following code:
```php