https://github.com/croct-tech/templates
A library of curated templates for UI components, projects, and personalization strategies.
https://github.com/croct-tech/templates
cms croct magicui nextjs react shadcn tailwindcss ui
Last synced: 4 months ago
JSON representation
A library of curated templates for UI components, projects, and personalization strategies.
- Host: GitHub
- URL: https://github.com/croct-tech/templates
- Owner: croct-tech
- License: mit
- Created: 2025-02-24T13:32:25.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T14:29:06.000Z (8 months ago)
- Last Synced: 2025-03-07T04:09:38.407Z (7 months ago)
- Topics: cms, croct, magicui, nextjs, react, shadcn, tailwindcss, ui
- Language: TypeScript
- Homepage: htttps://croct.com/templates
- Size: 63.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Croct Templates
A library of curated templates for UI components, projects, and personalization strategies.
## Introduction
We're creating the largest **CMS-powered UI component library** — think of it as [`shadcn`](https://github.com/shadcn-ui/ui) for CMS.
Just run `croct use ` to integrate a component into your application with **CMS, analytics, A/B testing, and personalization**.
### What's Croct?
Croct is a **Component CMS** designed for modern stacks with a developer-first mindset.
Built by seasoned open-source contributors, we offer a **💚 forever-free plan** — no credit card required — perfect for most teams and projects.
### 👉 Try it in Next.js
To use it with [Next.js](https://nextjs.org/), run:
```sh
croct use nextjs:/croct
```
This will either set up a new Next.js project or add the component to an existing one, fully configured.
## Installation
To use the Croct CLI, you need to have [Node.js](https://nodejs.org/) installed.
You can install the CLI globally using NPM:
```sh
npm install -g croct
```
Or run it directly using `npx`:
```sh
npx croct@latest use
```
## Basic usage
To use a template, **copy the URL** of the template you want to use and run:
```sh
croct use
```
For example:
```sh
croct use https://github.com/croct/templates/tree/main/templates/magicui/ui/marquee
```
This command will fetch and apply the template to your project automatically.
For more information, check the [documentation](https://docs.croct.com/reference/cli).
### Aliases
We support aliases for popular libraries, so you can skip the full URL. For example, to use the [Marquee](https://magicui.design/docs/components/marquee) component from [Magic UI](https://magicui.design/), you can run:
```sh
croct use magicui:/ui/marquee
```
Or use the component's registry URL:
```sh
croct use https://magicui.design/r/marquee
```
### Supported aliases
These are the currently supported aliases:
| Project | Short URL | Alternative URL |
|--------------|------------------------------------|-----------------------------------------------|
| **Any** | `github:///` | `https://github.com///` |
| **NPM** | `npm:/` | - |
| **Croct** | `croct:/` | - |
| **Next.js** | `nextjs:/` | - |
| **Shadcn** | `shadcn:/` | - |
| **Magic UI** | `magicui:/` | `https://magicui.design/r/` |
To add a new alias, open a pull request with the new entry in the [registry](templates/registry.json5).
## Contribute
Contributions are always welcome!
- Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/templates/issues).
- For major changes, please [open an issue](https://github.com/croct-tech/templates/issues) first to discuss what you would like to change.
### New templates
The best way to create a new template is to **base it on an existing one**. However, if you want to start from scratch, you can use:
```sh
npx croct create template --empty
```
This will generate a minimal template file ready for customization.
### Folder structure
This repository contains a structured folder system for organizing templates:
```
templates/
├── [organization]/
│ ├── example/
│ │ ├── template.json5
│ ├── another-example/
│ │ ├── template.json5
```
The `[organization]` should be the company's domain without `.com`, `.io`, or similar. For example, for `croct.com`, the folder name should be `croct`.
### Documentation
Check the [documentation](https://docs.croct.com/reference/cli/templates) for more information on how to create and publish templates.
## License
This library is licensed under the [MIT license](LICENSE).