-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d724d08
commit e80a2ba
Showing
1 changed file
with
47 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,58 @@ | ||
# README | ||
This is the repo [for the docs](https://phlexyui.com/) of PhlexyUI, a Ruby UI component library for DaisyUI using Phlex ✨ | ||
|
||
This README would normally document whatever steps are necessary to get the | ||
application up and running. | ||
# 🔧 Development | ||
|
||
Things you may want to cover: | ||
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. | ||
|
||
* Ruby version | ||
1. Visit [the docs](https://phlexyui.com/) to see which components are still not implemented or not yet added to the docs. | ||
|
||
* System dependencies | ||
2. Implement it. | ||
|
||
* Configuration | ||
3. After your PR is merged, add it to this repo. | ||
|
||
* Database creation | ||
4. Celebrate 🎉 | ||
|
||
* Database initialization | ||
## Using the generators | ||
|
||
* How to run the test suite | ||
You can use the generators to make your life easier: | ||
|
||
* Services (job queues, cache servers, search engines, etc.) | ||
**New component** | ||
|
||
* Deployment instructions | ||
If you're adding a new component, use `bin/rails generate example_view`. This generates a new component example view and a basic component. | ||
|
||
* ... | ||
e.g. `bin/rails generate example_view Card` | ||
|
||
This will create: | ||
|
||
- app/views/examples/cards/show_view.rb | ||
- app/views/components/examples/cards/basic_component.rb | ||
|
||
**New example** | ||
|
||
If you're adding a new example to an existing component, use `bin/rails generate example_component`. This generates a new component example. | ||
|
||
e.g. `bin/rails generate example_component Cards::Responsive "Optional title"` | ||
|
||
This will create: | ||
|
||
- app/views/components/examples/cards/responsive_component.rb | ||
|
||
# 💻 Contributing | ||
|
||
Bug reports and pull requests are welcome on GitHub at https://github.com/PhlexyUI/phlexy_ui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/phlexy_ui/blob/main/CODE_OF_CONDUCT.md). | ||
|
||
1. Visit [the docs](https://phlexyui.com/) to see which components are still not implemented or not yet added to the docs. | ||
|
||
2. Implement it. | ||
|
||
3. After your PR is merged, [add it to the docs](https://github.com/PhlexyUI/phlexy_ui_docs). | ||
|
||
4. Celebrate 🎉 | ||
|
||
# 📃 License | ||
|
||
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). | ||
|
||
# ☝️ Code of Conduct | ||
|
||
Everyone interacting in the PhlexyUI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phlexy_ui/blob/main/CODE_OF_CONDUCT.md). |