The figma for this project can be found here.
This project uses Atomic Design for it's Components. Here are several resources for Atomic Design if you are unfamiliar:
The Storybook for this project can be found at design-gsoc2.github.com/insights.
npm run storybookDeploy your branch (video explaining this)
Navigate to the Storybook Action. Choose your branch in the "Run Workflow" dropdown.
To install the application:
npm ciTo start a local copy of the app on port 3000:
npm run devTo start a local copy of the app on port 3000 with Netlify Edge Functions):
npm run dev:netlifyTo check the code and styles quality, use the following command:
npm run lintThis will also display during development, but not break on errors.
To fix the linting errors, use the following command:
npm run formatA production deployment is a complete build of the project, including the build of the static assets.
npm run buildWe can only take unsolicited contributions from OpenSauced Triage, Committers, and Maintainers for now. We suggest folks not on the team, to please open issues or take a look at the Bugs or Papercuts. If you would like to find good first issues, please check out the companion project to this, open-sauced/hot.
We encourage you to contribute to OpenSauced! Please check out the Contributing guide for guidelines about how to proceed.
We have a commit utility called @open-sauced/conventional-commit that helps you write your commits in a way that is easy to understand and process by others.
It is generally integrated as an npm script but you can run it with npx as well:
npm run pushFor any other npm based project or dotnpmrc defaulting to --yes:
npx -y @open-sauced/conventional-commitGot Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.