Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,21 @@ So people and/or organization can see the stats of programming language being us
### Supported environment:
* Prerequisite:
```bash
Node >= v18.18.0
NPM >= 9.5.0
Node >= 20.6.0+ (to enable .env support)
NPM >= 9.8.1
```

* [Generate access token (classic)](https://github.com/settings/tokens/new) with `repo` scope to ensure you don't get rate limited API call.

* Define environment variable with the following values:
* Copy `.env.example` to `.env` and fill in the required environment variables:
```
TOKEN=your-access-token
ENV=local
TOKEN=your_github_access_token_here
PORT=3000
```

An example of environment variable is provided [here](.env.example)

* Install dependency: `npm install`
* Start the app `<list-of-env-and-values> npm run start` and go to `http://localhost:3000`
* Start the app `npm run start:local` and go to `http://localhost:3000`

## Running with hot-reload
```bash
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
"type": "module",
"description": "show programming language based on the repos of github's account",
"engines": {
"node": "18.18.0",
"node": "20.6.0",
"npm": "9.5.0"
},
"main": "index.js",
"scripts": {
"start": "node src/api/app.js | gulp",
"start:local": "node --env-file=.env src/api/app.js | gulp",
"dev": "concurrently \"node src/api/app.js\" \"gulp watch\"",
"lint": "eslint '**/*.js' --ignore-pattern src/utils/*.js",
"lint:fix": "eslint --fix '**/*.js' --ignore-pattern node_modules/",
Expand Down
2 changes: 1 addition & 1 deletion src/pages/partials/body.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@
showLoader();
return true;
}
</script>
</script>