Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0-vortex/create-react-app-5-test
Experimenting with create-react-app@5 configuration repository for opensauced.pizza
https://github.com/0-vortex/create-react-app-5-test
Last synced: 9 days ago
JSON representation
Experimenting with create-react-app@5 configuration repository for opensauced.pizza
- Host: GitHub
- URL: https://github.com/0-vortex/create-react-app-5-test
- Owner: 0-vortex
- License: mit
- Created: 2021-12-16T23:45:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-20T09:29:57.000Z (almost 3 years ago)
- Last Synced: 2024-05-20T20:39:12.219Z (6 months ago)
- Language: JavaScript
- Size: 46.7 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
🍕 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](https://docs.github.com/en/free-pro-team@latest/graphql).
[
](https://opensauced.pizza)
## 🤝 Contributing
We encourage you to contribute to Open Sauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed.
### 📖 Prerequisites
In order to run the project from a container we need `node>=14`, `npm>=7` and `docker>=20` installed on our development machines.
### 🖥️ Local development
```sh
npm ci
npm start
```
### 🧪 Test
For running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html).
```sh
# the tests will run in watch mode by default
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](https://sauced-components.netlify.app/).
```sh
npm run storybook
```
### 🔑 Authentication
Authentication is handled through [OneGraph's AuthGuardian](https://www.onegraph.com/docs/auth_guardian.html) 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](https://github.com/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.
### 🌙 Dark Mode
This project supports "dark mode" styling, and by default it will follow the color preference on your device. It also allows for overriding this using buttons at the top right of the screen, which will persist the preference to local storage on your device. More info about color preference web API's can be found here: [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
### 📝 Markdown Support
This project leverages [Remirror](https://remirror.io/) for a delightful experience in documenting your Open Source goals. The editor supports markdown features including heading levels, bulleted lists, text formatting, code snippets, and emojis!
## 🍕 Community
Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).
## 🎦 Repository Visualization
[
](./src)
## ⚖️ LICENSE
MIT © [Open Sauced](LICENSE)