README.md

A front end library to help you make ​your​ grass greener than the other side

Contents

• Install
• Usage
• Documentation
• Contributing
• License

Install

You can manually download our latest release, or install with npm:

NPM

npm install garden

Bower

bower install garden

CDN

CSS

<link href="https://unpkg.com/garden/dist/css/garden.min.css" rel="stylesheet">

JavaScript

<script scr="https://unpkg.com/garden/dist/js/garden.min.js"></script>

Documentation

Garden documentation is built with Metalsmith and publicly hosted on Github Pages at http://styleguide.leroymerlin.com.br

Running locally

1. Run npm install.
2. Run npm run gulp.
3. Open http://localhost:3000 in your browser.

Using Docker

Alternatively, you can install and run the application using a docker container.

Installing Docker

On Ubuntu

• Install Docker Engine
• Install Docker Compose

On macOS

• Installation on macOS

On Windows

• Installation on Windows

Testing docker installation

Docker version:

docker --version

Docker-compose version:

docker-compose --version

Development

After having docker and docker-compose setup on your machine you can simply run these commands to run the project:

1. Run docker-compose build (Setup container)
2. Run docker-compose run --rm web npm install (Install dependencies)
3. Run docker-compose up (Run webserver)

Contributing

Checkout the contributing section to learn more on how to open issues, create pull requests, commit standards and more.

Versioning

Garden follows SEMVER standards

License

MIT License