Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update documentation #48

Merged
merged 3 commits into from
May 5, 2024
Merged

chore: update documentation #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0630f62
feat: document reCaptcha environment variables
nicopico-dev May 5, 2024
8ecbd67
feat: Update list of newsletters
nicopico-dev May 5, 2024
543f798
feat: do not run CI for non-build changes
nicopico-dev May 5, 2024
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
7 changes: 7 additions & 0 deletions .github/workflows/check-on-pull-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ on:
pull_request:
branches:
- main
paths-ignore:
- 'act/**'
- 'deploy/**'
- 'medias/**'
- 'stubs/**'
- 'n2rss.http'
- '*.md'

permissions:
checks: write
Expand Down
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ Once an email has been processed, it is marked as read.
Each newsletter will map to a separate RSS feed,
and each articles extracted from the newsletter publication will map to different RSS entry in the corresponding feed.

| Newsletter | URL | Status |
|----------------|---------------------------|--------|
| Android Weekly | https://androidweekly.net | OK |
| Kotlin Weekly | http://kotlinweekly.net | OK |
| Pointer | https://www.pointer.io | OK |
| Newsletter | URL | Status |
|----------------|-----------------------------------|--------|
| Android Weekly | https://androidweekly.net | OK |
| Kotlin Weekly | http://kotlinweekly.net | OK |
| Pointer | https://www.pointer.io | OK |
| QuickBird | https://quickbirdstudios.com/blog | OK |
| Built for Mars | https://builtformars.com | OK |

## Built With

Expand Down Expand Up @@ -172,6 +174,9 @@ This project needs access to an email account and a MongoDB database to run.
MONGODB_PORT=27017

N2RSS_SECRET_KEY=<secret key to interact with /stop endpoint>

N2RSS_RECAPTCHA_SITE_KEY=<Site key to interact with reCaptcha API>
N2RSS_RECAPTCHA_SECRET_KEY=<Secret key to interact with reCaptcha API>
```
4. Run the following command to run the server
```shell
Expand Down