Skip to content

Commit

Permalink
✨ readme + arq
Browse files Browse the repository at this point in the history
  • Loading branch information
perebaj committed Jan 24, 2024
1 parent 21090b5 commit bd7e421
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,9 @@ Some skilled engineers even have a blog site where they push some gold content,

![newsletter](./assets/newsletter.png)

## Architecture


# Roadmap

This program aims to create the following features:

- Given a list of websites, that are located in a MongoDB collection, scrape the content of each website and save it in another MongoDB collection. ✅
- After the scraping, calculate the similarity between the new content and the previous content of each website, and update the MongoDB collection
with this information. ✅
- All the registered users will receive an email according to the URL that they have registered notifying them about news in their favorite engineers websites. ✅

Obs: All these flows will be trigerred by a cron job. ✅

![architecture](./assets/newsletterarq.png)

## Environement Variables

Expand Down Expand Up @@ -49,4 +39,14 @@ Access the dev container and run the tests:
make integration-test
```

# Roadmap

This program aims to create the following features:

- Given a list of websites, that are located in a MongoDB collection, scrape the content of each website and save it in another MongoDB collection. ✅
- After the scraping, calculate the similarity between the new content and the previous content of each website, and update the MongoDB collection
with this information. ✅
- All the registered users will receive an email according to the URL that they have registered notifying them about news in their favorite engineers websites. ✅
- Create API routes to register new users and the websites that they want to follow. ⌛

Obs: All these flows will be trigerred by a cron job. ✅
Binary file added assets/newsletterarq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd7e421

Please sign in to comment.