Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucuma/Clay
An amazing HTML&CSS prototyping tool.
https://github.com/lucuma/Clay
Last synced: 3 months ago
JSON representation
An amazing HTML&CSS prototyping tool.
- Host: GitHub
- URL: https://github.com/lucuma/Clay
- Owner: lucuma
- License: mit
- Created: 2011-11-15T19:32:49.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T17:07:55.000Z (almost 2 years ago)
- Last Synced: 2024-08-14T18:35:49.923Z (4 months ago)
- Language: Python
- Homepage: https://lucuma.github.io/Clay/
- Size: 1.61 MB
- Stars: 111
- Watchers: 8
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Clay
[](https://coveralls.io/github/lucuma/Clay?branch=clay3) [](https://travis-ci.org/lucuma/Clay/)
**An amazing prototyping tool.**
With Clay you can forget about making changes to dozens of HTML files
just because you need to add a link in the footer.
You can also use it to prototype your AJAX-driven application or the
responses of sending forms, because it acts like a real server.
## Install
```
pip install clay
```
## Quickstart
```python
clay new mysite
```
will generate a new app container with the following structure:
```
mysite
├── static/
├── clay.yaml
├── index.html
└── ...other files
```
You can also use an optional project template path or git URL. For the URLs, "gh:" works as a shortcut of "https://github.com/" and "gl:" as a shortcut of "https://gitlab.com/". For example:
```python
# Absolute or relative path.
clay new myapp /path/to/project/template
# GitHub repo. Note the ".git" postfix.
clay new myapp https://github.com/lucuma/clay-template.git
# The same GitHub repo with shortcut
clay new myapp gh:/lucuma/clay-template.git
```
## Development server
Inside that folder, run the development server with:
```
clay run
```
and your site'll be available at ``http://0.0.0.0:8080/``.
Anything inside the `static` folder is served as-is under the `/static/` path.
For example you can see `myapp/static/image.png` at the `http://0.0.0.0:8080/static/image.png` URL.
Any file outside the `static` folder, is rendered as a page.
For example, `myapp/page.html` is rendered and shown at `http://0.0.0.0:8080/page.html`, as an HTML page.
And `myapp/foo/bar.json` is rendered and shown at `http://0.0.0.0:8080/foo/bar.json` as a JSON document.
Remember to put inside `static` anything you don't want to be rendered.
## Build version
To generate a static version of your site, first, stop the server with
``Control + C``, and then run:
```
clay build
```
and all the templates will be processed and the result stored inside the
`build` folder.
## Static files
If you have folders in your project, you might be tempted to write internal URLs like this
```html