Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-sauced/app
🍕 Insights into your entire open source ecosystem.
https://github.com/open-sauced/app
hacktoberfest nextjs open-source pizza react
Last synced: 4 days ago
JSON representation
🍕 Insights into your entire open source ecosystem.
- Host: GitHub
- URL: https://github.com/open-sauced/app
- Owner: open-sauced
- License: apache-2.0
- Created: 2022-06-07T22:55:43.000Z (over 2 years ago)
- Default Branch: beta
- Last Pushed: 2024-05-22T22:14:07.000Z (7 months ago)
- Last Synced: 2024-05-22T22:16:53.969Z (7 months ago)
- Topics: hacktoberfest, nextjs, open-source, pizza, react
- Language: TypeScript
- Homepage: https://pizza.new
- Size: 107 MB
- Stars: 349
- Watchers: 9
- Forks: 194
- Open Issues: 279
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
🍕 app.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:
- [Atomic Design by Brad Frost](https://bradfrost.com/blog/post/atomic-web-design/)
- [Atomic Design - How To Make Web and UI Design Easier](https://www.youtube.com/watch?v=W3A33dmp17E)
## 📙 Storybook
The Storybook for this project can be found at [design-insights.opensauced.pizza](https://design-insights.opensauced.pizza).
### Run it locally
```bash
npm run storybook
```
### Deploy your branch ([video explaining this](https://www.loom.com/share/c3a3fa04a4a343da8228bdb9b9a66746))
Navigate to the [Storybook Action](https://github.com/open-sauced/insights/actions/workflows/storybook.yml). Choose your branch in the "Run Workflow" dropdown.
## 🖥️ Local development
To install the application:
```shell
npm ci
```
To start a local copy of the app on port `3000`:
```shell
npm run dev
```
Interested in helping with potential performance problems? Run the dev server with [Million Lint](https://million.dev/lint). Note that Million Lint is currently only supported for VS Code and it requires the [Million Lint extension](https://marketplace.visualstudio.com/items?itemName=million.million-lint).
```shell
USE_MILLION_LINT=1 npm run dev
```
### ☁️️ Netlify Edge Functions
**Note**: For the best local development experience, it is recommended to have the `Netlify CLI` installed globally. Follow the [installation guide](https://docs.netlify.com/cli/get-started/) to set up Netlify CLI on your machine.
To start a local copy of the app on port `3000` with [Netlify Edge Functions](https://docs.netlify.com/edge-functions/overview/)):
```shell
netlify dev
```
### 🎨 Code linting
To check the code and styles quality, use the following command:
```shell
npm run lint
```
This will also display during development, but not break on errors.
To fix the linting errors, use the following command:
```shell
npm run format
```
### 🚀 Production deployment
A production deployment is a complete build of the project, including the build of the static assets.
```shell
npm run build
```
## 🤝 Contributing
_We encourage contributors to open issues or take a look at the [Bugs](https://github.com/orgs/open-sauced/projects/6) or [Papercuts](https://github.com/open-sauced/insights/issues?q=is%3Aopen+is%3Aissue+milestone%3APapercuts). If you would like to find **good first issues**, please check out the companion project to this, [open-sauced/hot](https://github.com/open-sauced/hot/issues) or check out the `#good-first-issues` channel in our [Discord](https://discord.gg/opensauced)._
We encourage you to contribute to OpenSauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to self-assign an issue and how to get started.
We have a commit utility called [@open-sauced/conventional-commit](https://github.com/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:
```shell
npm run push
```
For any other npm based project or dotnpmrc defaulting to `--yes`:
```shell
npx -y @open-sauced/conventional-commit
```
## 🍕 Community
Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
Find OpenSauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ), and check out the resources on our [Dev.to org](https://dev.to/opensauced).