{"id":22327210,"url":"https://github.com/getninjas/gaiden","last_synced_at":"2025-07-29T18:30:58.206Z","repository":{"id":12002901,"uuid":"70271676","full_name":"getninjas/gaiden","owner":"getninjas","description":"GetNinjas Styleguide","archived":false,"fork":false,"pushed_at":"2022-12-04T05:21:59.000Z","size":6499,"stargazers_count":30,"open_issues_count":11,"forks_count":4,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-11-08T06:47:35.972Z","etag":null,"topics":["bem-methodology","css","styleguide"],"latest_commit_sha":null,"homepage":"https://getninjas.github.io/gaiden","language":"CSS","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/getninjas.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}},"created_at":"2016-10-07T18:17:25.000Z","updated_at":"2024-07-22T17:19:56.000Z","dependencies_parsed_at":"2023-01-14T05:15:21.400Z","dependency_job_id":null,"html_url":"https://github.com/getninjas/gaiden","commit_stats":null,"previous_names":[],"tags_count":136,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getninjas%2Fgaiden","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getninjas%2Fgaiden/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getninjas%2Fgaiden/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getninjas%2Fgaiden/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getninjas","download_url":"https://codeload.github.com/getninjas/gaiden/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228035005,"owners_count":17859245,"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":["bem-methodology","css","styleguide"],"created_at":"2024-12-04T03:08:46.767Z","updated_at":"2024-12-04T03:08:47.262Z","avatar_url":"https://github.com/getninjas.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Gaiden Logo](/public/images/logo-gaiden.png)\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1e3706db28f946f29cc0e5e2258f479f)](https://www.codacy.com/app/eduardojmatos/gaiden?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=getninjas/gaiden\u0026utm_campaign=badger) [![npm version](https://badge.fury.io/js/gaiden.svg)](https://badge.fury.io/js/gaiden)\n\nGetNinjas Styleguide - https://getninjas.github.io/gaiden\n\n# Quick Start\n- Clone the repository: `git clone https://github.com/getninjas/gaiden.git`\n- Install dependencies with: `npm install`\n- Configure the build links with: `npm run config`\n\n# Build Process\n\nThe `npm run build` command, generated files into the `dist` folder, separated `themes` file.\n\n# Release process\n\nWe are using `npm version` to generate our releases. There are 3 kind of releases generally used: major, minor and patch. See the http://semver.org/ for more details.\n\nThe process is:\n\n1. After merge PR on master:\n\n    ```bash\n    git checkout master\n    git pull --tags origin master\n    ```\n\n2. Run `npm run version` command.\n\n3. Run `npm version major|minor|patch -m \"Message of your changes\"` (important: you need to be an admin to push on master).\n\n4. Now let's publish the package on npm:\n    1. If you not have access to Org GetNinjas in NPM, you need ask for users in Org to add you.\n    2. If nothing fails on `npm version` and you have the credentials of npm GetNinjas account, run `npm publish`.\n\n5. Done! Now, you can install the package on any project!\n\n# Deploy to gh-pages\n\n1. Run `npm run deploy-storybook` to publish static site in gh-pages;\n\n2. Access this link https://getninjas.github.io/gaiden/ and enjoy it!\n\n# Commands\n\nHere are a description of the scripts that we have in the project:\n\n| **Script**       | **Description**                                                                                            |\n|------------------|-------------------------------------------------------------------------------------------------------------|\n| storybook        | Start storybook for development purposes                                                                    |\n| build-storybook  | Build storybook for deploy. The output is in `docs` folder                                                     |\n| deploy-storybook | Deploy storybook in github-pages                                                                            |\n| version          | Build the project and add the dist folder to git stage                                                      |\n| postversion      | Script that runs after the version (due to naming conventions). Push the changes and the tags to the branch |\n| build            | Build the library                                                                                           |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetninjas%2Fgaiden","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetninjas%2Fgaiden","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetninjas%2Fgaiden/lists"}