{"id":20859176,"url":"https://github.com/bearstudio/start-ui-web-docs","last_synced_at":"2025-05-12T08:32:13.155Z","repository":{"id":65269016,"uuid":"573853985","full_name":"BearStudio/start-ui-web-docs","owner":"BearStudio","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-22T08:58:59.000Z","size":14231,"stargazers_count":11,"open_issues_count":21,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-07-23T08:55:18.536Z","etag":null,"topics":["documentation","nextjs","react","start-ui","typescript"],"latest_commit_sha":null,"homepage":"https://docs.web.start-ui.com","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BearStudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-12-03T16:37:27.000Z","updated_at":"2024-07-22T08:59:01.000Z","dependencies_parsed_at":"2024-01-02T17:24:40.637Z","dependency_job_id":"7400f588-e0cc-4eab-a4d1-f363f7648aad","html_url":"https://github.com/BearStudio/start-ui-web-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"shuding/nextra-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BearStudio%2Fstart-ui-web-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BearStudio%2Fstart-ui-web-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BearStudio%2Fstart-ui-web-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BearStudio%2Fstart-ui-web-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BearStudio","download_url":"https://codeload.github.com/BearStudio/start-ui-web-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225130736,"owners_count":17425506,"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":["documentation","nextjs","react","start-ui","typescript"],"created_at":"2024-11-18T04:48:53.515Z","updated_at":"2024-11-18T04:48:53.630Z","avatar_url":"https://github.com/BearStudio.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# This is Start UI [web] documentation repository\n\n\u003ch1 align=\"center\"\u003e\u003cimg src=\".github/assets/thumbnail.png\" alt=\"Start UI Web\" /\u003e\u003c/h1\u003e\n\n[![Discord](https://img.shields.io/discord/452798408491663361)](https://go.bearstudio.fr/discord)\n\n🚀 Start UI \u003csmall\u003e[web]\u003c/small\u003e is an opinionated frontend starter repository created \u0026 maintained by the [BearStudio Team](https://www.bearstudio.fr/team) and other contributors.\nIt represents our team's up-to-date stack that we use when creating web apps for our clients.\n\n\n# Contribution\n\n## Getting Started\n\n```bash\npnpm install\npnpm dev\n```\n\nThe documentation uses Nextra from Vercel, so it's based on NextJS. You can check the [documentation](https://nextra.site) for more information.\n\n## Integrate screenshots\n\nFor keep consistency between all documentation's screenshots, make sure to follow up these rules :\n\n1. Desktop screenshots dimensions are 1280x800\n2. Mobile screenshots dimensions are 390x844 (iPhone 12 Pro)\n3. Screenshots have to be with application in dark mode\n4. Put every feature/guide's screenshots in a folder named like `my-feature` in `public/images/screenshots/my-feature`\n5. Import screenshots using `@/screenshots/my-feature/my-screenshot` path\n\nHere is a tutorial for make perfect screenshots for this documentation (with Google Chrome)\n\n1. If set, deactivate scrollbar always display\n2. Go to [start-ui [web]](https://demo.start-ui/com), and then go the page you want to screen\n3. Open the developer tools, and open device toolbar\n4. 1. For desktop screenshot, set dimensions manually at 1280x800 (you can create a custom device with these dimensions).\n   2. For mobile screenshot, set dimensions to iPhone 12 Pro (or manually at 390x844)\n5. Click on three dots on the right of device toolbar and click on \"Capture screenshot\"\n6. The screenshot is download with dimensions defined\n\n## Components\n\nSome components have been developed and could be used in documentation pages.\n\n### `ImageTabs`\n\nA component to display images as content of Nextra Tabs component. It is used to display screenshots as desktop or mobile version.\n\n### `Stack`\n\nFlex container that allows to define direction and gap.\n\n### `ResponsiveStack`\n\nHorizontal Stack which will become vertical when the device width is lower than breakpoint prop (default is to 768px)\n\n### `WorkInProgress`\n\nComponent based on Nextra Callout, to warn user that a page is not yet written.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearstudio%2Fstart-ui-web-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbearstudio%2Fstart-ui-web-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearstudio%2Fstart-ui-web-docs/lists"}