Skip to content

Commit

Permalink
docs(contributing): update contributing docs to mention maxDuration t…
Browse files Browse the repository at this point in the history
…o 10 (#1734)

* Update docs to mention maxDuration to 10

I forked the project and tried running it, but got an error saying 

The value for maxDuration must be between 1 second and 10 seconds, in order to increase this limit upgrade your plan: https://vercel.com/pricing

- We have to set the maxDuration to 10 for free plans in vercel.json

* docs(contributing.md): improve syntax

Co-authored-by: rickstaa <rick.staa@outlook.com>
  • Loading branch information
VivekNeel and rickstaa committed May 8, 2022
1 parent 1bf4705 commit 0264bc5
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@ Interested in diving deeper into understanding how github-readme-stats works?
To run & test github-readme-stats, you need to follow a few simple steps:-
_(make sure you already have a [Vercel](https://vercel.com/) account)_

1. Install [Vercel CLI](https://vercel.com/download)
2. Fork the repository and clone the code to your local machine
3. Run `npm install` in the repository root
4. Run the command "vercel" in the root and follow the steps there
5. Create a `.env` file in the root of the directory
6. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
7. Run the command "vercel dev" to start a development server at <https://localhost:3000>
1. Install [Vercel CLI](https://vercel.com/download).
2. Fork the repository and clone the code to your local machine.
3. Run `npm install` in the repository root.
4. Run the command "vercel" in the root and follow the steps there.
5. Open `vercel.json` and set the maxDuration to 10.
6. Create a `.env` file in the root of the directory.
7. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
8. Run the command "vercel dev" to start a development server at <https://localhost:3000>.

## Themes Contribution

Expand Down

1 comment on commit 0264bc5

@vercel
Copy link

@vercel vercel bot commented on 0264bc5 May 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.