# MonsterUI Getting Started
## Installation
To install this library, uses
`pip install MonsterUI`
## Getting Started
### TLDR
Run `python file.py` on this to start:
``` python
from fasthtml.common import *
from monsterui.all import *
# Choose a theme color (blue, green, red, etc)
hdrs = Theme.blue.headers()
# Create your app with the theme
app, rt = fast_app(hdrs=hdrs)
@rt
def index():
socials = (('github','https://github.com/AnswerDotAI/MonsterUI'),
('twitter','https://twitter.com/isaac_flath/'),
('linkedin','https://www.linkedin.com/in/isaacflath/'))
return Titled("Your First App",
Card(
H1("Welcome!"),
P("Your first MonsterUI app", cls=TextPresets.muted_sm),
P("I'm excited to see what you build with MonsterUI!"),
footer=DivLAligned(*[UkIconLink(icon,href=url) for icon,url in socials])))
serve()
```
## LLM context files
Using LLMs for development is a best practice way to get started and
explore. While LLMs cannot code for you, they can be helpful assistants.
You must check, refactor, test, and vet any code any LLM generates for
you - but they are helpful productivity tools. Take a look inside the
`llms.txt` file to see links to particularly useful context files!
- [llms.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms.txt): Links to what is included
- [llms-ctx.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms-ctx.txt): MonsterUI Documentation Pages
- [API list](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/apilist.txt): API list for MonsterUI (included in llms-ctx.txt)
- [llms-ctx-full.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms-ctx-full.txt): Full context that includes all api reference pages as markdown
In addition you can add `/md` (for markdown) to a url to get a markdown representation and `/rmd` for rendered markdown representation (nice for looking to see what would be put into context.
### Step by Step
To get started, check out:
1. Start by importing the modules as follows:
``` python
from fasthtml.common import *
from monsterui.all import *
```
2. Instantiate the app with the MonsterUI headers
``` python
app = FastHTML(hdrs=Theme.blue.headers())
# Alternatively, using the fast_app method
app, rt = fast_app(hdrs=Theme.slate.headers())
```
> *The color option can be any of the theme options available out of the
> box*
From here, you can explore the API Reference & examples to see how to
implement the components. You can also check out these demo videos to as
a quick start guide:
- MonsterUI [documentation page and Tutorial
app](https://monsterui.answer.ai/tutorial_app)
- Isaac & Hamel : [Building his website’s team
page](https://youtu.be/22Jn46-mmM0)
- Isaac & Audrey : [Building a blog](https://youtu.be/gVWAsywxLXE)
- Isaac : [Building a blog](https://youtu.be/22NJgfAqgko)
More resources and improvements to the documentation will be added here
soon!
Raw data
{
"_id": null,
"home_page": "https://github.com/AnswerDotAI/MonsterUI",
"name": "MonsterUI",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "isaac flath",
"author_email": "isaac.flath@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/29/328b820cd6ce44cc26014fee42232cf93e6862616b30bb29f1c33f5b4f3e/monsterui-1.0.6.tar.gz",
"platform": null,
"description": "# MonsterUI Getting Started\n\n## Installation\n\nTo install this library, uses\n\n`pip install MonsterUI`\n\n## Getting Started\n\n### TLDR\n\nRun `python file.py` on this to start:\n\n``` python\nfrom fasthtml.common import *\nfrom monsterui.all import *\n\n# Choose a theme color (blue, green, red, etc)\nhdrs = Theme.blue.headers()\n\n# Create your app with the theme\napp, rt = fast_app(hdrs=hdrs)\n\n@rt\ndef index():\n socials = (('github','https://github.com/AnswerDotAI/MonsterUI'),\n ('twitter','https://twitter.com/isaac_flath/'),\n ('linkedin','https://www.linkedin.com/in/isaacflath/'))\n return Titled(\"Your First App\",\n Card(\n H1(\"Welcome!\"),\n P(\"Your first MonsterUI app\", cls=TextPresets.muted_sm),\n P(\"I'm excited to see what you build with MonsterUI!\"),\n footer=DivLAligned(*[UkIconLink(icon,href=url) for icon,url in socials])))\n\nserve()\n```\n\n## LLM context files\n\nUsing LLMs for development is a best practice way to get started and\nexplore. While LLMs cannot code for you, they can be helpful assistants.\nYou must check, refactor, test, and vet any code any LLM generates for\nyou - but they are helpful productivity tools. Take a look inside the\n`llms.txt` file to see links to particularly useful context files!\n\n- [llms.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms.txt): Links to what is included\n- [llms-ctx.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms-ctx.txt): MonsterUI Documentation Pages\n- [API list](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/apilist.txt): API list for MonsterUI (included in llms-ctx.txt)\n- [llms-ctx-full.txt](https://raw.githubusercontent.com/AnswerDotAI/MonsterUI/refs/heads/main/docs/llms-ctx-full.txt): Full context that includes all api reference pages as markdown\n\nIn addition you can add `/md` (for markdown) to a url to get a markdown representation and `/rmd` for rendered markdown representation (nice for looking to see what would be put into context.\n\n### Step by Step\n\nTo get started, check out:\n\n1. Start by importing the modules as follows:\n\n``` python\nfrom fasthtml.common import *\nfrom monsterui.all import *\n```\n\n2. Instantiate the app with the MonsterUI headers\n\n``` python\napp = FastHTML(hdrs=Theme.blue.headers())\n\n# Alternatively, using the fast_app method\napp, rt = fast_app(hdrs=Theme.slate.headers())\n```\n\n> *The color option can be any of the theme options available out of the\n> box*\n\nFrom here, you can explore the API Reference & examples to see how to\nimplement the components. You can also check out these demo videos to as\na quick start guide:\n\n- MonsterUI [documentation page and Tutorial\n app](https://monsterui.answer.ai/tutorial_app)\n- Isaac & Hamel : [Building his website\u2019s team\n page](https://youtu.be/22Jn46-mmM0)\n- Isaac & Audrey : [Building a blog](https://youtu.be/gVWAsywxLXE)\n- Isaac : [Building a blog](https://youtu.be/22NJgfAqgko)\n\nMore resources and improvements to the documentation will be added here\nsoon!\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "The simplicity of FastHTML with the power of Tailwind",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/AnswerDotAI/MonsterUI"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "387763fa49b0982942e44a79af7337821b24f7e9de228d716a227f821ec6d4cf",
"md5": "be929b8fc4c4d644b4f01fe1eeecab45",
"sha256": "212491de8a275c07a2e363c0dd5120436d7350a14a5459de2921a12d0d2fc3fd"
},
"downloads": -1,
"filename": "MonsterUI-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be929b8fc4c4d644b4f01fe1eeecab45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31063,
"upload_time": "2025-02-12T15:42:08",
"upload_time_iso_8601": "2025-02-12T15:42:08.806407Z",
"url": "https://files.pythonhosted.org/packages/38/77/63fa49b0982942e44a79af7337821b24f7e9de228d716a227f821ec6d4cf/MonsterUI-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3729328b820cd6ce44cc26014fee42232cf93e6862616b30bb29f1c33f5b4f3e",
"md5": "4b89a325f5e24e0e0bf2fb491b7c0216",
"sha256": "b0d52cd6a2676d40d4813086f5c84aaa85939b7f575b6371230fd10a228846ca"
},
"downloads": -1,
"filename": "monsterui-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "4b89a325f5e24e0e0bf2fb491b7c0216",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 31161,
"upload_time": "2025-02-12T15:42:09",
"upload_time_iso_8601": "2025-02-12T15:42:09.896217Z",
"url": "https://files.pythonhosted.org/packages/37/29/328b820cd6ce44cc26014fee42232cf93e6862616b30bb29f1c33f5b4f3e/monsterui-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 15:42:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnswerDotAI",
"github_project": "MonsterUI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "monsterui"
}
JSON
