brunodevel / garden Goto Github PK

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

• Install
• Usage
• Documentation
• Contributing
• License

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

npm install garden

bower install garden

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>

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

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

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

• Install Docker Engine
• Install Docker Compose

• Installation on macOS

• Installation on Windows

Docker version:

docker --version

Docker-compose version:

docker-compose --version

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)

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

Garden follows SEMVER standards

MIT License