Skip to content

Some problems and solutions when deploying with vercel #823

@Sherlock1956

Description

@Sherlock1956

I encountered several problems while I am trying to deploy github-readme-streak-stats on vercel(free). But I figure them out finally, here I provide some solutions, hope it will be useful.

Here are some problems I encountered.

  • Vercel is deprecating Node 18 so that directly import the GitHub repo and deploy can not work. Solution below.
  • After I import the repo and deploy on vercel, the screenshot display ".env was not found. Check Contributing.md for details.". Solution below.
  • After I figure out how to solve the problem above and successfully deploy on vercel(as figure 1), I can not use markdown or html link at other place, which means it can not be used in my own readme.md file.

figure 1

How to solve these problems

  • Here is an PR with "node 18 deprecated" chore: update devcontainer to 24.04 and bump Node.js to 22.x #815 , the most important part is changing the node version from 18 to 22 in the package.json file in you own forked repo. Then it can be deployed in vercel
  • Here is an issue discussing the ".env was not found..."problem [ERROR] [Deployment] .env was not found. Check Contributing.md for details. #419 , there is a solution solution -> fork the repo into a private repo and change the ".env.example" file into ".env" and put your own github key into it. However it is not recommended because even though the repo is private, it is not 100% safe to put your github key here. On the other hand, I didn't find it successful with this method. The solution is adding your key in vercel(as figure 2). Then it can work.

figure 2

- Third, I found that when I want to access the readme-streak link through web browser, It sometimes ask me to login to my vercel account, so I guess the reason why I can't access in markdown or html is that It can not pass the authentication. So I searched the vercel setting, and I found there is a Vercel Authentication(as in figure 3), when I disable this, those links can work eveywhere.

figure 3

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions