https://github.com/cyevgeniy/open-checklist-catalog
https://github.com/cyevgeniy/open-checklist-catalog
checklist checklists open-checklists
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cyevgeniy/open-checklist-catalog
- Owner: cyevgeniy
- Created: 2025-08-06T15:02:06.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2026-02-07T13:14:33.000Z (4 months ago)
- Last Synced: 2026-02-07T22:08:12.770Z (4 months ago)
- Topics: checklist, checklists, open-checklists
- Language: Vue
- Homepage: https://open-checklists.netlify.app/
- Size: 759 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Checklists catalog
A web interface for working with open-checklists.
## Running locally
1. `npm i`
2. `npm run dev`
## How it works
Checklists catalog uses [Nuxt Content](https://content.nuxt.com/) for
working with checklists.
Just create a `.json` file in the `content` directory.
To create an open-checklists json file you can use [the constructor](https://github.com/cyevgeniy/open-checklist-constructor).
## Customization
To customize appearance of the catalog, the `catalog.ts` file is used.
Configuration example:
```ts
export const config = defineConfig({
githubUrl: 'https://github.com/cyevgeniy',
title: 'Open Checklists',
nav: [
{text: 'What is it?', link: 'https://github.com', target: "_blank"},
{text: 'Want my own!', link: '/list-own'}
],
footer: {
text: 'Open Checklists, 2025'
}
})
```
`defineConfig` function accepts `Config` object:
```ts
interface Config {
/**
* Link to a github repo
*/
githubUrl?: string
/**
* The title of the site.
* Will be shown in the header
*/
title: string
nav?: NavLink[]
footer?: Footer
}
```
### `NavLink`
```ts
interface NavLink {
/**
* Link text
* @example 'My projects'
*/
text: string
/**
* URL of the link
* @example 'https://example.com'
* @example '/list-own'
*/
link: string
/**
* target attribute
* @example '_blank'
*/
target?: string
}
```
### `Footer`
```ts
interface Footer {
/**
* Text to display in the footer
* @example 'Made with Nuxt by John Doe'
*/
text?: string
}
```
### Icons
You can add an icon to the checklist card by extending your checklists with
`_icon` field. It should contain an icon name from Iconify:
```json
{
"title": "Create own checklists catalog",
"description": "",
"created_at": "2025-08-15",
"_icon": "carbon:carbon",
"items": [
...
]
}
```
### tags
You can add a tags list to each checklist with the `_tags` field:
```json
{
"title": "Signup and login forms",
"_tags": ["form", "example"],
"items": [
...
]
}
```
## Misc
Icon for the logo: `icon-park-outline:check-one`.
Color: #12a627;