Modularity Products

title: "README" date: 2021-05-27 draft: false layout: default parent: Boilerplates

Modularity Products

An addon for displaying products.
Report Bug · Request Feature

Table of Contents

• Table of Contents
• [About Modularity Products](#about-Modularity Products)
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Deploy
• Roadmap
• Contributing
• License
• Acknowledgements

About Modularity Products

Here's a blank template to get started:

Built With

• PHP
• NPM
• Webpack
• Modularity

Getting Started

To get a local copy up and running follow these simple steps.

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-products.git

2. Install and build NPM packages

   npm install && npm run build

3. Install composer packages

   composer install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Deploy

Instructions for deploys.

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