{"id":28241829,"url":"https://github.com/significa/foundations","last_synced_at":"2025-06-11T09:31:38.289Z","repository":{"id":272944266,"uuid":"852721351","full_name":"significa/foundations","owner":"significa","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-23T09:12:23.000Z","size":3485,"stargazers_count":10,"open_issues_count":9,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-23T11:03:51.424Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://foundations.significa.co","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/significa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-05T09:57:08.000Z","updated_at":"2025-05-23T09:12:24.000Z","dependencies_parsed_at":"2025-01-17T16:27:05.492Z","dependency_job_id":"4fed2a16-fd08-44e4-9745-cf22f0da20e8","html_url":"https://github.com/significa/foundations","commit_stats":null,"previous_names":["significa/foundations"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/significa%2Ffoundations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/significa%2Ffoundations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/significa%2Ffoundations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/significa%2Ffoundations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/significa","download_url":"https://codeload.github.com/significa/foundations/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/significa%2Ffoundations/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259238826,"owners_count":22826805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-19T05:08:51.769Z","updated_at":"2025-06-11T09:31:38.275Z","avatar_url":"https://github.com/significa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Foundations\n\nFoundations is an opinionated collection of components, patterns, and guidelines for building consistent and accessible user interfaces. Inspired by projects like [shadcn](https://ui.shadcn.com/), the goal is to allow developers to copy components into their projects and customize them as needed, or simply take inspiration to build their own versions.\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [Authoring](#authoring)\n  - [Folder Structure](#folder-structure)\n  - [Code Previews](#code-previews)\n  - [Metadata](#metadata)\n  - [Markdown](#markdown)\n- [License](#license)\n- [Contributing](#contributing)\n- [Acknowledgments](#acknowledgments)\n\n## Getting Started\n\nTo get the project running locally, follow these steps:\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/significa/foundations.git\n   cd foundations\n   ```\n\n2. **Install dependencies:**\n\n   ```bash\n   npm install\n   ```\n\n3. **Run the development server:**\n\n   ```bash\n   npm run dev\n   ```\n\n   This will start the server and watch for changes.\n\n## Authoring\n\nDocumentation pages are written in `.mdx` format. For a complete example, check out [markdown-example](./markdown-example.mdx).\n\n### Folder Structure\n\nThe `src/foundations` folder contains all the foundational content and follows a specific convention:\n\n- `page.mdx`: Used to create the documentation page.\n- Source files are added to the root of the folder.\n- Any file ending in `.preview.tsx` will be made available as a preview (see \"Code Previews\" below).\n\n### Code Previews\n\nWhile developing, you can visit `/preview/[slug]` to open a `[slug].preview.tsx` file. This makes it easier to develop in isolation.\n\nYou can include a `layout` query parameter to configure the preview layout:\n\n- `/preview/[slug]?layout=centered` (default): centers your component in the screen\n- `/preview/[slug]?layout=padded`: adds just a small padding to the page\n- `/preview/[slug]?layout=fullscreen`: displays your component fullscreen\n\n### Metadata\n\nEach `page.mdx` file should include the following metadata structure:\n\n| Field          | Type   | Description                                         | Required |\n| -------------- | ------ | --------------------------------------------------- | -------- |\n| `title`        | String | The title of the docs page.                         | Yes      |\n| `description`  | String | A brief description of the docs page.               | No       |\n| `preview`      | String | The slug of a \"Code Preview\" to be used as a cover. | No       |\n| `files`        | Array  | List of source files.                               | No       |\n| `dependencies` | Array  | List of dependencies, each with a name and href.    | No       |\n\n#### Dependencies Structure\n\nEach dependency in the `dependencies` array should have the following structure:\n\n| Field  | Type   | Description                 | Required |\n| ------ | ------ | --------------------------- | -------- |\n| `name` | String | The name of the dependency. | Yes      |\n| `href` | String | URL to the dependency.      | Yes      |\n\nThis metadata is crucial for ensuring that each documentation page is properly structured and provides all necessary information.\n\n### Markdown\n\nWe use [GitHub Flavored Markdown Spec](https://github.github.com/gfm/). Additionally, several components are available for use without importing them. For a complete list of these components, refer to the `markdown.tsx` file.\n\n## License\n\nThis project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html).\n\n## Acknowledgments\n\n[Shadcn](https://ui.shadcn.com/) and [Lucia Auth](https://lucia-auth.com/) serve as excellent examples of robust foundational platforms that people can use to build upon. This project aspires to combine the strengths of both by offering ready-to-use components alongside detailed guides and recipes, simplifying the process of kickstarting any project.\n\n---\n\nFor more details, refer to the codebase and explore the components and patterns provided.\n\nBuilt by [Significa](https://significa.co).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignifica%2Ffoundations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsignifica%2Ffoundations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignifica%2Ffoundations/lists"}