\n\n \n \nTarmac is fleet.co's Design System. It is based on create-react-library, styled-components.\n
\n
\n\n## List of components\n\n- Modal ({Modal})\n- Confirmation Modal : yes or no modals ({ConfirmationModal})\n- Alert : alert message, mainly used in modals ({Alert})\n- Switch/Toggle ({Switch})\n- Label ({Label})\n- Line : grey line to separate items ({Line})\n- Title ({Title})\n\n \nOngoing development : Button ({Button}), , Input\n\n
\n\n## Use local version in your project\n\nFirst, make a local copy of this repo and reach to its folder with your IDE. \nRun command\n\n```bash\nnpm build\n```\n\nThis will create a dist folder. Reach to it with your IDE and run command\n\n```bash\nnpm link\n```\n\nNow reach to your project's folder and run\n\n```bash\nnpm link @fleet.co/tarmac\n```\n\nIn your project's folder, navigate to your node_modules/react folder then\n\n```bash\nnpm link\n```\n\nGo back to the Design System folder and\n\n```bash\nnpm link react\n```\n\nThis will create 2 symlinks to use your local DS in your local project.\nNow launch your design system and your project\n\n```bash\nnpm run start\n```\n\n
\n\n## Use example\n\nTo ease the new components creation, you will find an example project within the Design System itself. \nTo launch it, navigate to your DS folder/example and write\n\n```bash\nnpm run start\n```\n\nIn the App.js file in the example folder, call your newly created components as described in \"Usage\" section.\n\n
\n\n## Publish a new version\n\nTo publish the new version of your DS to npm, run\n\n```bash\nnpm run publish-package\n```\n\nThis will create a new build, patch the current version, publish to npm and push changes to master. \nIf everything went smoothly, you will see the following message in your IDE : \"Design System successfully updated to X.X.X\"\n \n\nWait for the new version to be released on npm, then go back to your project's folder and install it\n\n```bash\nnpm i @fleet.co/tarmac\n```\n\n
\n\n## Usage\n\n```jsx\nimport React from 'react'\n\nimport { MyComponent } from '@fleet.co/tarmac'\n\nconst myPage = () => {\n return \n}\n```\n\n
\n\n## Troubleshooting\n\nIn case you're facing issue at installing the DS locally, please make sure no process is currently running in both your project and the DS. If so, kill them all and try the \"use locally\" procedure again. \nYou may also have to delete your node_modules folders in both your project and the DS. Then reinstall all packages in both folders and try the \"use locally\" procedure again. \nIf you get an error related to React Hooks after launching your project, it is probably related to the fact you have two different instance of React running in your project and in the DS (ie your symlink didn't work). Kill all process, redo the react symlink and start again. \n\n
![](\"./public/images/logo.png\"/){kind=logo}
\n