About

Markup is the starting point of a simple, automated-tasking project with pug, sass, bootstrap v4 and font-awesome.

Requirements

• Node: ^10.15
• Yarn: ^1.13

Installation

Create a markup project via composer.

composer create-project --prefer-dist d1s1g4codelovers/markup your-markup-project

Change your working directory.

cd /path/to/your-markup-project

Install node dependencies via yarn.

yarn install

Usage

Create pug files inside resources/templates directory (Similar to resources/templates/items directory).

resources/templates/
├── app.pug
├── index.pug
└── items
    ├── create-edit.pug
    ├── index.pug
    └── show.pug

Register pug files in webpack.mix.js file.

const config = {
    pug: {
        locals: {
            templates: {
                items: [
                    { name: 'index', description: 'List Items' },
                    { name: 'create-edit', description: 'Create/Edit Item' },
                    { name: 'show', description: 'Show Item' },
                ],
            },
        },
    },
};

Build/Watch files (See webpack.mix.js for more details).

yarn run dev # yarn run development
yarn run prod # yarn run production
yarn run watch

Start a node server (expressjs)

yarn start # http://127.0.0.1:3000

Visit http://127.0.0.1:3000.

Supported enviroment variables:

MIX_PORT=8080 # Specify a server HTTP port.
MIX_NOTIFIED=on # Enable/Disable compiling notifications. (on/off)

Contributing

• Thank you for considering contributing to @d1s1g4codelovers/markup package!

• Feel free to submit an issue or a pull request for your expectation!

• All contributions are welcome and accepted via pull requests.

License

• The @d1s1g4codelovers/markup package is open-sourced software licensed under the MIT license.