Skip to content

Commit df7b693

Browse files
committed
docs: Add notes about Node 18.x in Vercel instructions
1 parent 100fb7d commit df7b693

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ package-lock.json
88
.vercel
99

1010
# Local Configuration
11-
package.json
1211
.DS_Store
1312

1413
# Environment

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ The longest streak is the highest number of consecutive days on which you have m
146146

147147
The current streak is the number of consecutive days ending with the current day on which you have made at least one contribution. If you have made a contribution today, it will be counted towards the current streak, however, if you have not made a contribution today, the streak will only count days before today so that your streak will not be zero.
148148

149-
> **Note**
149+
> [!NOTE]
150150
> You may need to wait up to 24 hours for new contributions to show up ([Learn how contributions are counted](https://docs.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile))
151151
152152
## 📤 Deploying it on your own
@@ -163,12 +163,13 @@ The Inkscape dependency is required for PNG rendering, as well as Segoe UI font
163163

164164
Vercel is the recommended option for hosting the files since it is **free** and easy to set up. Watch the video below or expand the instructions to learn how to deploy to Vercel.
165165

166-
> **Note** PNG mode is not supported since Inkscape will not be installed but the default SVG mode will work.
166+
> [!NOTE]
167+
> PNG mode is not supported since Inkscape will not be installed but the default SVG mode will work.
167168
168169
### 📺 [Click here for a video tutorial on how to self-host on Vercel](https://www.youtube.com/watch?v=maoXtlb8t44)
169170

170171
<details>
171-
<summary><b>Instructions for deploying to Vercel</b></summary>
172+
<summary><b>Instructions for deploying to Vercel (Free)</b></summary>
172173

173174
### Step-by-step instructions for deploying to Vercel
174175

@@ -190,6 +191,11 @@ Vercel is the recommended option for hosting the files since it is **free** and
190191

191192
![deployment](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/32092461-5983-4fed-b21b-29be55ed85e8)
192193

194+
> ⚠️ **Note**
195+
> If you receive an error related to libssl or Node 20.x, you can fix this by opening your Vercel project settings and changing the Node.js version to 18.x.
196+
>
197+
> ![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/5fb18fb5-debe-4620-9c8b-193ab442a617)
198+
193199
#### Option 2: Deploy to Vercel manually
194200

195201
1. Sign in to **Vercel** or create a new account at <https://vercel.com>
@@ -207,7 +213,14 @@ Vercel is the recommended option for hosting the files since it is **free** and
207213

208214
![image](https://user-images.githubusercontent.com/20955511/209588756-8bf5b0cd-9aa6-41e8-909c-97bf41e525b3.png)
209215

210-
> **Note** To set up automatic Vercel deployments from GitHub, make sure to turn **off** "Include source files outside of the Root Directory" in the General settings and use `vercel` as the production branch in the Git settings.
216+
> ⚠️ **Note**
217+
> To set up automatic Vercel deployments from GitHub, make sure to turn **off** "Include source files outside of the Root Directory" in the General settings and use `vercel` as the production branch in the Git settings.
218+
219+
> ⚠️ **Note**
220+
> If you receive an error related to libssl or Node 20.x, you can fix this by opening your Vercel project settings and changing the Node.js version to 18.x.
221+
>
222+
> ![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/5fb18fb5-debe-4620-9c8b-193ab442a617)
223+
211224

212225
</details>
213226

@@ -216,7 +229,7 @@ Vercel is the recommended option for hosting the files since it is **free** and
216229
Heroku is another great option for hosting the files. All features are supported on Heroku and it is where the default domain is hosted. Heroku is not free, however, and you will need to pay between \$5 and \$7 per month to keep the app running. Expand the instructions below to learn how to deploy to Heroku.
217230

218231
<details>
219-
<summary><b>Instructions for deploying to Heroku</b></summary>
232+
<summary><b>Instructions for deploying to Heroku (Paid)</b></summary>
220233

221234
### Step-by-step instructions for deploying to Heroku
222235

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"engines": {
3+
"node": "18.x"
4+
},
5+
"devDependencies": {
6+
"@prettier/plugin-php": "^0.18.8",
7+
"prettier": "^2.6.2"
8+
}
9+
}

0 commit comments

Comments
 (0)