Open source, feature rich React boilerplate used to kickstart production ready web apps.
Starts a local dev server at localhost:8080. The port can be customized by updating the PORT environment variable in .env.local.
Starts a local Storybook server and opens it in your browser.
The app is hosted on AWS using S3, CloudFront, ACM, and Route53.
CircleCI is configured to deploy to different environments based on changes to key branch names.
| Branch Name | Environment |
|---|---|
production |
production |
staging |
staging |
dev, develop |
dev |
This command will first build the app in production mode, meaning code will be minified and no local dev server will be started, using the appropriate environment config variables.
npm run deploy:staging
npm run deploy:production
Storybook is an open source tool for developing UI components in isolation
All new components should have an accompanying .stories.mdx file containing the story and documentation.
npm run storybook
Use Plop to scaffold new components automatically. To add or modify plop templates, see plopfile.js and config/plop/.
npx plop Component
npx plop Page
Coding style is enforced using ESLint. You can also manually run the linter using npm run lint:fix.