2.7 KiB

Raw Permalink Blame History

Sakura v2

This repo is under developement, do not active in production environment!

Install

Clone/download into ./wp-content/themes/, install the depended plugin WPGraphQL (for GraphQL API support), then active the theme in WordPress dashboard after compiling.

Compile

npm i -g webpack-cli
npm install
# Dynamical compile (--watch file changes)
npm run dev
# Build
npm run build

Commands tested on Linux, should also work on other platforms.

Develop

DO NOT MODIFY OR SAVE IN ./dist/, all your changes inside this folder will be replaced after npm run build. Develop by changing files in ./src/.

.
├── dist               // Compiled files (*DO NOT SAVE HERE*)
│   ├── css            // Stylesheets (compiled)
│   ├── js             // JavaScript (compiled)
│   ├── images         // Images (compiled)
│   ├── *.php          // PHP files (compiled)
│   ├── manifest.json  // Webpack manifest resources list
│   └── style.css      // Wordpress theme info
├── src                // Source code (develop inside this folder)
│   ├── scss           // CSS source code (SASS)
│   ├── ts             // JavaScript source code (TypeScript)
│   ├── images         // Images resources
│   ├── php            // PHP source code
│   └── package.scss   // Wordpress theme info (header of style.css)
├── package.json       // Node.js configuration
├── tsconfig.json      // TypeScript configuration
└── webpack.config.js  // Webpack configuration

Contribute

Pull requests welcomed. Code comments and commit tags in English, please.

Git commit guidelines: the Angular guidelines

Code comment guidelines: the TypeScript guidelines

Author

Mashiro https://2heng.xin

License

MIT

2.7 KiB Raw Permalink Blame History