Based on Lee Briggs' deja-dev,
the purpose of this scaffolding tool is to enable us to painlessly skip the
boilerplate and start working on the real meat of our projects as soon as possible.
Built using the SAO framework.
Built on the SvelteKit framework, with TypeScript support and:
- Tailwind CSS, a utility-first CSS framework
- figma2theme, our tool for generating a Tailwind theme from a Figma UI Kit file
- Storybook for building and testing components in isolation
- Vitest for writing unit tests
- with Svelte Testing Library integration for better testing practices
- Playwright for writing end-to-end tests
- ESLint for identifying code problems
- Prettier for consistent code formatting
- Plop for generating boilerplate (e.g. a component with a story and a test)
- Various additional features and code examples
View the README.md for more info.
Built on the Next.js framework, with TypeScript support and using:
- Chakra UI, an accessible and themeable component library
- figma2theme, our tool for generating a Chakra UI theme from a Figma UI Kit file
- Storybook, for building and testing components in isolation
- Jest, for writing unit tests
- with React Testing Library integration for better testing practices
- Cypress for writing end-to-end tests
- with Cypress Testing Library integration for better testing practices
- ESLint, for identifying code problems
- Prettier, for consistent code formatting
- Plop, for generating code (e.g. a component with stories and tests)
- Built-in third-party integrations:
- Sentry, for error tracking and performance monitoring
- Google Analytics, for monitoring traffic
- Various additional features and code examples
View the README.md for more info.
Generate your project using the following command:
npx sao PortableStudios/easey#main -u <project-folder>Now install the dependencies and create your initial commit:
cd <project-folder>
nvm install
yarn install
git add .
git commit -am "Initial commit generated by Easey scaffolding tool"You can test the tool locally by running the following command from the parent directory:
npx sao ./easey -u <project-folder>The easiest way to make changes to the templates while testing them is running the following commands from the parent directory:
npx sao ./easey -u <project-folder>
cd <project-folder>
nvm install
yarn install
git add .
git commit -am "Initial commit"Now any changes you make to the project can be viewed in Git and copied back to the template after testing.
MIT © Portable