https://github.com/pglevy/notion-uikit
https://github.com/pglevy/notion-uikit
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pglevy/notion-uikit
- Owner: pglevy
- License: mit
- Created: 2022-02-21T20:28:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-21T20:39:17.000Z (over 4 years ago)
- Last Synced: 2025-05-15T13:51:33.661Z (about 1 year ago)
- Language: HTML
- Homepage: https://pglevy.github.io/notion-uikit/
- Size: 347 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Trap Kit | The no-cost, no-catch rapid web prototyping toolkit for no-coders to get real feedback real fast.
**Trap Kit** is a “fauxcode” toolkit of components, layouts, and templates to build working prototypes in the browser using the human-friendliest tech stack around: [Markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for content, [USWDS](https://designsystem.digital.gov/) for components, and [GitHub Pages](https://pages.github.com/) for hosting. All free and open-source.
**Visit the public-facing site at [trapkit.co](https://trapkit.co).**
## 🏗 How it works
This repository template provides everything you need to get started with rapid web prototyping. These are the high-level steps:
1. Create content and link it together with [GitHub-flavored Markdown](https://github.github.com/gfm/).
1. Add [USWDS components](https://designsystem.digital.gov/components/overview/) to your pages with a line or two of text.
1. Go live with GitHub Pages and get feedback.
## Getting started
> **There are instructional videos forthcoming, but for now, here are the high-level instructions on how to start using it.**
If you want to learn more about how it works, [check out the documentation in the wiki](https://github.com/pglevy/trapkit/wiki).
If you want to jump right in:
1. Create a copy of this repo template. (Keep the name `trapkit` to start to keep hosting simple.)
1. Turn on [GitHub Pages](https://pages.github.com/) in the repo Settings.
1. Run the site locally using Gitpod by pasting this in front of your repo URL and loding that in your browser: `https://gitpod.io/#`.
- Alternatively, if you have Jekyll installed, you can run it directly on your machine.
1. Check out the templates and the [component kitchen sink](https://pglevy.github.io/trapkit/docs/component-kitchen-sink.html) and start making some content pages.
If you need any help, [reach out on Twitter](https://twitter.com/pglevy).