Modularity Boilerplate

A boilerplate repo for modules.
Report Bug · Request Feature

Table of Contents

• Table of Contents
• About Modularity Boilerplate
  • Built With
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Acknowledgements

About Modularity Boilerplate

Create a new module at record speed! Read the installation instructions below. Setup files will automaticly be removed upon setup.

Built With

• PHP
• NPM
• Webpack
• Modularity

Prerequisites

This is an example of how to list things you need to use the software and how to install them (mac os).

• composer

brew install composer

• npm

brew install node

• modularity

composer require helsingborg-stad/modularity

Installation

1. Clone the repo

git clone https://github.com/helsingborg-stad/modularity-boilerplate.git

2. Edit setup.json file, add your details

nano setup.json

3. Run setup procedure

php setup.php

4. Install and build NPM packages

npm install && npm run build

5. Install composer packages

composer install

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Acknowledgements

• othneildrew Best README Template