🍕 Open Sauced 🍕
The path to your next Open Source contribution
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.
🤝 Contributing
We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.
📖 Prerequisites
- Node.js: we recommend using nvm to install the Node version.
- NPM: please refer to their installation guide.
🖥️ 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
🔑 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