Skip to content

Commit

Permalink
Remove cron package and add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hernandoagf committed May 21, 2021
1 parent 7f6ea36 commit 30578e5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
REPO_AND_BRANCH = "https://raw.githubusercontent.com/1Hive/pollen/gh-pages/"
MONGODB_URI = "Your MongoDB connection URI"
GITHUB_API_TOKEN = "Your GitHub API Token (it needs write permissions)"
REPO = "Your instance repo"
BRANCH = "The branch you want to work on"
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pollen-onboarding

A script to add new users to the ledger every 6 hours
A script to add, merge and activate new users in the ledger every 6 hours

## Developer setup

Expand All @@ -10,10 +10,13 @@ A script to add new users to the ledger every 6 hours

### Add env variables

<!-- Copy the content of your `.env.sample` file into a new `.env` file and add the corresponding variables:
Copy the content of your `.env.sample` file into a new `.env` file and add the corresponding variables:

- `REPO_AND_BRANCH` = The repo and branch of your sourcecred instance. In this case it's `https://raw.githubusercontent.com/1Hive/pollen/gh-pages/`
- `MONGODB_URI` = Your MongoDB connection URI. -->
- `MONGODB_URI` = Your MongoDB connection URI.
- `GITHUB_API_TOKEN` = GitHub token with commit permissions to the repo.
- `REPO` = The repo you want to commit to.
- `BRANCH` = The branch you want to commit to.

### Run the script!

Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@
"typescript": "^4.2.4"
},
"dependencies": {
"@types/cron": "^1.7.2",
"@types/mongoose": "^5.10.5",
"@types/node": "^14.14.41",
"cron": "^1.8.2",
"dotenv": "^9.0.0",
"mongodb": "^3.6.6",
"mongoose": "^5.12.7",
Expand Down

0 comments on commit 30578e5

Please sign in to comment.