System-End/github-readme-stats
1
0
Fork 0
mirror of https://github.com/System-End/github-readme-stats.git synced 2026-04-20 00:35:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(contributing): remove outdated local dev steps (#3358)

Browse source 
This commit removes some local development steps found in the
contributing guide that are no longer required.
This commit is contained in:
Rick Staa 2023-10-16 18:50:28 +02:00 • committed by GitHub
parent 365dfb7ffb
commit 4e949c2bc2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -34,11 +34,8 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
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>.
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
5. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
6. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
> [!NOTE]\
> You can debug the package code in [Vscode](https://code.visualstudio.com/) by using the [Node.js: Attach to process](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_setting-up-an-attach-configuration) debug option. You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information, see https://github.com/jest-community/vscode-jest/issues/912.