Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rinaldilucas/compass-example

Simple example of a project with compass, yarn and gulp.
https://github.com/rinaldilucas/compass-example

compass gulp scss yarn

Last synced: about 6 hours ago
JSON representation

Simple example of a project with compass, yarn and gulp.

Awesome Lists containing this project

README

        

[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]





Logo

Compass example


A simple example using SASS with compass, yarn and gulp
to jumpstart your studies or start your business.




Explore the docs »


Open
·
Donate


Table of Contents



  1. About The Project



  2. Getting Started


  3. Contributing

  4. License

  5. Contact

  6. Donations

## About The Project

[![Project Screenshot][project-screenshot]](https://rinaldilucas.github.io/compass-example/)

A little study project created to help people who wants to know how a project with compass, gulp and yarn works. If this project helped you in any way, don't hesitate to leave a star!

(back to top)

### Built With

This section shows what technologies are used in this particular project.

- [Yarn](https://yarnpkg.com/)
- [Gulp](https://gulpjs.com/)
- [Sass](https://sass-lang.com/)
- [Compass](http://compass-style.org/)

(back to top)

## Getting Started

After cloning the project, you need to do a few things to be able to run it.

### Prerequisites

You need to have the following requirements:

- ruby (download here)
- node 10 (download here)
- compass
```
gem install compass
```
- npm
```sh
npm install -g npm
```

- yarn
```sh
npm install -g yarn
```
- gulp cli
```sh
npm install -g gulp-cli
- compass
```sh
gem install compass
```

### Installation

_Below is an example of how you can run the project._

1. Clone the repo
```sh
git clone https://github.com/rinaldilucas/compass-example.git
```
2. Install the dependencies via yarn
```sh
yarn install
```
3. Build the project to develop
```js
npm run dev
```
4. Build the dist folder
```js
npm run build
```

(back to top)

## Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

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

(back to top)

## License

Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.

(back to top)

## Contact

[![Website](https://img.shields.io/badge/-Website-0078D4?style=flat-square&logo=html5&logoColor=white&link=https://rinaldilucas.com)](https://rinaldilucas.com)
[![Github](https://img.shields.io/badge/-Github-967bb5?style=flat-square&labelColor=967bb5&logo=github&logoColor=white&link=https://github.com/rinaldilucas
)](https://github.com/rinaldilucas)
[![Gmail Badge](https://img.shields.io/badge/-Gmail-c14438?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])
[![Hotmail Badge](https://img.shields.io/badge/-Hotmail-0078D4?style=flat-square&logo=microsoft-outlook&logoColor=white&link=mailto:[email protected])](mailto:[email protected])
[![Linkedin Badge](https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/rinaldilucas/)](https://www.linkedin.com/in/rinaldilucas/)
[![Telegram Badge](https://img.shields.io/badge/-Telegram-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=telegram&logoColor=white&link=https://t.me/rinaldilucas)](https://t.me/rinaldilucas)

Project Link: [https://github.com/rinaldilucas/compass-example](https://github.com/rinaldilucas/compass-example)

(back to top)

## Donations

If you feel that this project has helped you in any way, whether it's attracting clients or teaching you about the technologies used, feel free to make a donation.
It helps me a lot to continue developing open source codes.

- Metamask (USDT):
```sh
0x16362DF7f963CeEBB2114B467B68F5A58972ee65
```
- PIX (BRL):
```sh
72140bc8-fadc-42f5-abb6-9c13cc80a59f
```

(back to top)

[forks-shield]: https://img.shields.io/github/forks/rinaldilucas/compass-example.svg?style=for-the-badge
[forks-url]: https://github.com/rinaldilucas/compass-example/network/members
[stars-shield]: https://img.shields.io/github/stars/rinaldilucas/compass-example.svg?style=for-the-badge
[stars-url]: https://github.com/rinaldilucas/compass-example/stargazers
[license-shield]: https://img.shields.io/github/license/rinaldilucas/compass-example.svg?style=for-the-badge
[license-url]: https://github.com/rinaldilucas/compass-example/blob/main/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/rinaldilucas/
[project-screenshot]: ./sources/assets/images/_readme/screenshot.jpg