Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/chiefpansancolt/simplecov-tailwindcss

Simplecov Output of HTML using Tailwind UX design
https://github.com/chiefpansancolt/simplecov-tailwindcss

ruby ruby-on-rails simplecov simplecov-tailwind tailwind

Last synced: 5 days ago
JSON representation

Simplecov Output of HTML using Tailwind UX design

Host: GitHub
URL: https://github.com/chiefpansancolt/simplecov-tailwindcss
Owner: chiefpansancolt
License: mit
Created: 2020-08-07T21:53:31.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-02-19T21:49:29.000Z (9 months ago)
Last Synced: 2024-10-20T08:04:19.540Z (17 days ago)
Topics: ruby, ruby-on-rails, simplecov, simplecov-tailwind, tailwind
Language: HTML
Homepage: https://simplecov-tailwind.chiefpansancolt.dev/
Size: 1.28 MB
Stars: 29
Watchers: 1
Forks: 6
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Simplecov Tailwind

[![GitHub](https://img.shields.io/github/license/chiefpansancolt/simplecov-tailwindcss?label=License&style=flat-square)](/LICENSE)

[![GitHub Workflow Tests Status](https://img.shields.io/github/actions/workflow/status/chiefpansancolt/simplecov-tailwindcss/tests.yml?label=Tests&logo=github&style=flat-square)](https://github.com/chiefpansancolt/simplecov-tailwindcss/actions/workflows/tests.yml)

[![GitHub Workflow Builds Status](https://img.shields.io/github/actions/workflow/status/chiefpansancolt/simplecov-tailwindcss/builds.yml?label=Build&logo=github&style=flat-square)](https://github.com/chiefpansancolt/simplecov-tailwindcss/actions/workflows/builds.yml)

[![GitHub Workflow Lints Status](https://img.shields.io/github/actions/workflow/status/chiefpansancolt/simplecov-tailwindcss/lints.yml?label=Lints&logo=github&style=flat-square)](https://github.com/chiefpansancolt/simplecov-tailwindcss/actions/workflows/lints.yml)

[![CodeQL](https://github.com/chiefpansancolt/simplecov-tailwindcss/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/chiefpansancolt/simplecov-tailwindcss/actions/workflows/github-code-scanning/codeql)

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/chiefpansancolt/simplecov-tailwindcss?label=Release&logo=github&style=flat-square)](https://github.com/chiefpansancolt/simplecov-tailwindcss/releases)

[![Gem](https://img.shields.io/gem/v/simplecov-tailwindcss?color=orange&label=Gem%20Version&logo=rubygems&style=flat-square)](https://rubygems.org/gems/simplecov-tailwindcss)

[![Discord](https://img.shields.io/discord/450095227185659905?label=Discord&logo=discord&style=flat-square)](https://discord.gg/pBxGpfrmD4)

> Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/simplecov

Generates a HTML Tailwind Design report generated from Simplecov using ruby 2.5 or greater.

## Installation and Usage

Checkout the [Documentation](https://simplecov-tailwind.chiefpansancolt.dev) for full details.

## Change Log

Check out the [Change Log](https://github.com/chiefpansancolt/simplecov-tailwindcss/blob/main/CHANGELOG.md) for new breaking changes/features/bug fixes per release of a new version.

## Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/simplecov-tailwindcss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/chiefpansancolt/simplecov-tailwindcss/blob/main/.github/CODE_OF_CONDUCT.md) code of conduct.

To see more about Contributing check out this [document](https://github.com/chiefpansancolt/simplecov-tailwindcss/blob/main/.github/CONTRIBUTING.md).

- Fork Repo and create new branch

- Once all is changed and committed create a pull request.

**Ensure all merge conflicts are fixed and CI is passing.**

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `pnpm test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

When working with CSS or JS ensure to run `pnpm build` to compile tailwind and JS to the public folder. This will ensure you have the latest CSS and JS used when testing locally.

_**NOTE: Do not commit any changes made in public folder from compiling as this will be performed by the owner before building of a release.**_

To test locally run `pnpm test` and a webpage will open after tests are complete and you will be able to see the page.

To install this gem onto your local machine, run `pnpm gem:build`. Gems will be built/release by Owner.

## License

Simplecov Tailwind is available as open source under the terms of the [MIT License](https://github.com/chiefpansancolt/simplecov-tailwindcss/blob/main/LICENSE).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Christopher Pezza}
💻 📖 🔧 ⚠️ 🚧

  

This project follows the

[all-contributors](https://github.com/all-contributors/all-contributors)

specification. Contributions of any kind welcome!