Skip to content

Commit fc28ad2

Browse files
committed
docs: add information on how to handle secrets
1 parent 5de12f4 commit fc28ad2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This is an evolution of [this proof of concept (POC)](https://github.com/UlisesG
66

77
- Node.js 22 and npm
88
- Docker and Docker Compose
9+
- Github token with repo:read level access.
910

1011
## Infrastructure
1112

@@ -28,6 +29,23 @@ To stop the infrastructure, run the following command:
2829
npm run infra:stop
2930
```
3031

32+
## Configuration
33+
34+
### Environment Variables
35+
36+
This project requires a GitHub token to access the GitHub API. You need to set the `GITHUB_TOKEN` environment variable.
37+
38+
#### Optional: use .env file
39+
40+
Create a `.env` file and add your GitHub token:
41+
42+
```sh
43+
GITHUB_TOKEN=your_github_token_here
44+
```
45+
46+
then use `--env-file` flag to load it, like `node --env-file=.env index.js workflow run --name populate-repos-list`
47+
48+
3149
## Database Management
3250

3351
### Running Migrations

0 commit comments

Comments
 (0)