Skip to content

dominicduffin1/open-sauced-insights

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


Open Sauced

πŸ• insights.opensauced.pizza πŸ•

The site provides insights to Open Source projects.

πŸ–ΌοΈ Project Figma

The figma for this project can be found here.

πŸ”¬ Atomic Design

This project uses Atomic Design for it's Components. Here are several resources for Atomic Design if you are unfamiliar:

πŸ“™ Storybook

The Storybook for this project can be found at design-insights.opensauced.pizza.

Run it locally

npm run storybook

Deploy your branch (video explaining this)

Navigate to the Storybook Action. Choose your branch in the "Run Workflow" dropdown.

storybook action tab

πŸ–₯️ Local development

To install the application:

npm ci

To start a local copy of the app on port 3000:

npm run dev

🎨 Code linting

To check the code and styles quality, use the following command:

npm run lint

This will also display during development, but not break on errors.

To fix the linting errors, use the following command:

npm run format

πŸš€ Production deployment

A production deployment is a complete build of the project, including the build of the static assets.

npm run build

🀝 Contributing

We 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 push

For any other npm based project or dotnpmrc defaulting to --yes:

npx -y @open-sauced/conventional-commit

πŸ• Community

Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.

About

πŸ• The path to your next contribution.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.5%
  • JavaScript 1.4%
  • Other 0.1%