Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.91 KB

README.md

File metadata and controls

93 lines (67 loc) · 3.91 KB

Open Sauced

🍕 Open Sauced 🍕

The path to your next Open Source contribution

Node CI Netlify Status Dependabot Badge GitHub code size in bytes GitHub commit activity GitHub issues GitHub Release Discord Twitter

Open Sauced provides structured onboarding for new contributors to open source. This structure provides a way to track your next contributions by leveraging a unique dashboard built on top of the GitHub GraphQL API.

open-sauced-screencap

🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.

📖 Prerequisites

🖥️ Local development

npm install
npm start

🧪 Test

npm test

// to clean snapshots
npm run clean

📙 Storybook

Storybook is being leveraged to mock out visual React components. The latest version of the design system can be found at this url.

npm run storybook

storybook example screenshot

🔑 Authentication

Authentication is handled through OneGraph's AuthGuardian service.

💾 Database

This project uses GitHub as a database. When you login, you will be presented with a button to create a goals repository. That repository template lives at open-sauced/goals-template.

💨 Service Worker

This project uses the sw-precache to kickstart an offline cache. The offline cache only registers in production. If service needs to be manually removed make an unregister call from the registerServiceWorker.js import.

🍕 Community

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

⚖️ LICENSE

MIT © Open Sauced