@profoundry-us/loco_motion 0.0.8 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,19 +6,45 @@ ViewComponent, TailwindCSS, DaisyUI and more!
|
|
|
6
6
|
|
|
7
7
|
<img src="//loco-motion-docs.profoundry.us/images/loco-chats.png" width="500px" style="border: 1px solid #bbb; padding: 2px; border-radius: 10px;">
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
<!-- omit from toc -->
|
|
10
|
+
## DISCLAIMER / CURRENT STATUS
|
|
10
11
|
|
|
11
12
|
This project is in active development and many changes occur with every release!
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
to
|
|
13
|
+
|
|
14
|
+
We've added a very basic / untested version of all DaisyUI 4 components. While
|
|
15
|
+
we originally intended to take some time to flesh out and attempt to use these
|
|
16
|
+
components, with the recent release of Tailwind 4 and DaisyUI 5, we feel our
|
|
17
|
+
time is best spent updating all of the components and dependencies for these
|
|
18
|
+
new releases.
|
|
19
|
+
|
|
20
|
+
This means that we will **NOT** be making any bug fixes to the current branch
|
|
21
|
+
(0.4.0), and will instead include any bug fixes / improvements into the 0.5.0
|
|
22
|
+
branch which will also upgrade to Tailwind 4 and DaisyUI 5.
|
|
23
|
+
|
|
24
|
+
- Current Release **(0.4.0)** - Works with DaisyUI 4 and Tailwind 3
|
|
25
|
+
- Next Release **(0.5.0)** - Will work with DaisyUI 5 and Tailwind 4
|
|
26
|
+
|
|
27
|
+
<!-- omit from toc -->
|
|
28
|
+
## Additional Notes
|
|
29
|
+
|
|
30
|
+
### DataInput Components
|
|
31
|
+
|
|
32
|
+
Many of the DataInput elements (file input, text input, select dropdown, etc)
|
|
33
|
+
were built rather hastily so that we would have a base version to start from.
|
|
34
|
+
|
|
35
|
+
However, the new DaisyUI 5 components are implemented in a much cleaner way and
|
|
36
|
+
we didn't want to invest too much time building these out and making them more
|
|
37
|
+
ideal since we're about to change them.
|
|
38
|
+
|
|
39
|
+
### Hosting / Sites
|
|
15
40
|
|
|
16
41
|
We expect to settle on and purchase a real domain name in the near future, but
|
|
17
42
|
for the time being, the latest documentation is available at the links below.
|
|
18
43
|
|
|
19
|
-
- [
|
|
20
|
-
- [
|
|
21
|
-
|
|
44
|
+
- [Latest Release][1]
|
|
45
|
+
- [Main / Staging][3]
|
|
46
|
+
|
|
47
|
+
### Getting Help
|
|
22
48
|
|
|
23
49
|
Please reach out by opening an
|
|
24
50
|
[Issue](https://github.com/profoundry-us/loco_motion/issues) if you've found a
|
|
@@ -47,6 +73,8 @@ your solution is aligned with our goals.
|
|
|
47
73
|
- [Install](#install)
|
|
48
74
|
- [Using Components](#using-components)
|
|
49
75
|
- [Developing](#developing)
|
|
76
|
+
- [Contributing](#contributing)
|
|
77
|
+
- [Releasing](#releasing)
|
|
50
78
|
- [Tooling](#tooling)
|
|
51
79
|
- [TODO / Next Steps](#todo--next-steps)
|
|
52
80
|
|
|
@@ -856,6 +884,20 @@ See the `Makefile` for all available commands.
|
|
|
856
884
|
> make demo-restart
|
|
857
885
|
> ```
|
|
858
886
|
|
|
887
|
+
### Contributing
|
|
888
|
+
|
|
889
|
+
If you're interested in contributing to LocoMotion, please check out our
|
|
890
|
+
[CONTRIBUTING guide](docs/dev_guides/CONTRIBUTING.md) which provides detailed
|
|
891
|
+
information about the contribution process, code standards, documentation
|
|
892
|
+
requirements, and testing procedures.
|
|
893
|
+
|
|
894
|
+
### Releasing
|
|
895
|
+
|
|
896
|
+
For core team members who need to release new versions of LocoMotion, please
|
|
897
|
+
refer to our [RELEASING guide](docs/dev_guides/RELEASING.md) for step-by-step
|
|
898
|
+
instructions on version updates, building, testing, and publishing both the Ruby
|
|
899
|
+
gem and NPM package.
|
|
900
|
+
|
|
859
901
|
### Tooling
|
|
860
902
|
|
|
861
903
|
For VSCode, you may want to add the following to your settings to get
|
|
@@ -919,9 +961,9 @@ the GitHub Discussions feature and let us know!
|
|
|
919
961
|
- [x] Basic versions of DaisyUI Data Display
|
|
920
962
|
- [x] Basic versions of DaisyUI Navigation
|
|
921
963
|
- [x] Basic versions of DaisyUI Feedback
|
|
922
|
-
- [
|
|
923
|
-
- [
|
|
924
|
-
- [
|
|
964
|
+
- [x] Basic versions of DaisyUI Data Input
|
|
965
|
+
- [x] Basic versions of DaisyUI Layout
|
|
966
|
+
- [x] Basic versions of DaisyUI Mockup
|
|
925
967
|
- [x] ~~Get YARD docs rendering with (better) Markdown~~ _**Working for now**_
|
|
926
968
|
- [x] Extract relevant pieces into a yard-loco_motion plugin
|
|
927
969
|
- [x] Publish Gem
|
|
@@ -932,9 +974,9 @@ the GitHub Discussions feature and let us know!
|
|
|
932
974
|
- [ ] Choose, recommend, and document a pagination gem
|
|
933
975
|
- [ ] Discuss caching techniques / setup
|
|
934
976
|
- [x] Create / publish a staging version of the demo site ([Demo Staging][2])
|
|
935
|
-
- [
|
|
936
|
-
- [
|
|
937
|
-
- [
|
|
977
|
+
- [x] Create / publish a staging version of the docs site
|
|
978
|
+
- [x] Create / publish a production version of the demo site
|
|
979
|
+
- [x] Create / publish a production version of the docs site
|
|
938
980
|
- [x] Update demo site to allow for a different docs site using ENV var
|
|
939
981
|
- [x] Update README to suggest Playwright
|
|
940
982
|
- [ ] Build some have docs / guides / examples for using playwright-ruby-client
|
|
@@ -946,6 +988,7 @@ the GitHub Discussions feature and let us know!
|
|
|
946
988
|
- [ ] See if we can update the Join component to auto-add the `join-item` CSS
|
|
947
989
|
under certain conditions
|
|
948
990
|
- [ ] Add title and description content_for blocks to all examples for SEO purposes
|
|
991
|
+
- [ ] Update to Tailwind 4 and DaisyUI 5
|
|
949
992
|
|
|
950
993
|
[1]: https://loco-motion.profoundry.us/
|
|
951
994
|
[2]: https://loco-motion-demo-staging.profoundry.us/
|