Skip to content
This repository has been archived by the owner on May 25, 2023. It is now read-only.

Commit

Permalink
feat: implement @open-sauced/check-engines and update docs (#1141)
Browse files Browse the repository at this point in the history
closes #1140
  • Loading branch information
0-vortex committed Oct 10, 2021
1 parent a5710e3 commit 7944367
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 18 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ audit-level="moderate"
loglevel="info"
progress=false
timing=false
engine-strict=true
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

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).

[![open-sauced-screencap](/src/images/homepage.png)
[![open-sauced-screencap](./src/images/homepage.png)
](https://opensauced.pizza)

## 🤝 Contributing
Expand All @@ -42,9 +42,7 @@ We encourage you to contribute to Open Sauced! Please check out the [Contributin

### 📖 Prerequisites

- [Node.js](https://nodejs.org/en/): we recommend using [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to install the Node version.
- [NPM](https://npmjs.com/): please refer to their [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
+ `terser-webpack-plugin` minimum supported Node.js version is 10.13
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

Expand Down
76 changes: 75 additions & 1 deletion npm-shrinkwrap.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 16 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,31 @@
"url": "git+ssh://git@github.com/open-sauced/open-sauced.git"
},
"engines": {
"node": ">=16",
"node": ">=14",
"npm": ">=7"
},
"scripts": {
"preinstall": "npx @open-sauced/check-engines",
"prestart": "npx @open-sauced/check-engines",
"start": "node scripts/start.js",
"build": "node scripts/build.js",
"clean": "rimraf src/tests/__snapshots__/",
"test": "npm run clean && node scripts/test.js --env=jsdom --updateSnapshot",
"storybook": "start-storybook -p 6006 -s ./.storybook",
"build-storybook": "build-storybook -s ./.storybook",
"push": "cz",
"lint": "eslint . --report-unused-disable-directives",
"format": "npm run lint -- --fix",
"semantic-release": "semantic-release"
},
"devDependencies": {
"@babel/core": "^7.15.8",
"@babel/eslint-parser": "^7.15.8",
"@babel/plugin-proposal-class-properties": "^7.14.5",
"@babel/plugin-transform-runtime": "^7.15.8",
"@babel/register": "^7.15.3",
"@babel/runtime": "^7.15.4",
"@open-sauced/check-engines": "^1.0.0",
"@open-sauced/semantic-release-conventional-config": "^1.3.0",
"@storybook/addon-essentials": "^6.3.10",
"@storybook/addon-links": "^6.3.10",
Expand Down Expand Up @@ -106,18 +121,6 @@
"styled-components": "^5.3.1",
"swr": "^1.0.1"
},
"scripts": {
"start": "node scripts/start.js",
"build": "node scripts/build.js",
"clean": "rimraf src/tests/__snapshots__/",
"test": "npm run clean && node scripts/test.js --env=jsdom --updateSnapshot",
"storybook": "start-storybook -p 6006 -s ./.storybook",
"build-storybook": "build-storybook -s ./.storybook",
"push": "cz",
"lint": "eslint . --report-unused-disable-directives",
"format": "npm run lint -- --fix",
"semantic-release": "semantic-release"
},
"jest": {
"moduleFileExtensions": [
"jsx",
Expand Down

0 comments on commit 7944367

Please sign in to comment.