From f94bf587a9e9ddf0254a8dbcea23457f23ffa5a3 Mon Sep 17 00:00:00 2001 From: Amelia <9247739-limesey@users.noreply.gitlab.com> Date: Mon, 6 Jun 2022 15:18:59 +0100 Subject: [PATCH] Update README.md --- Portuguese-README.md | 3 --- README.md | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 3 deletions(-) delete mode 100644 Portuguese-README.md diff --git a/Portuguese-README.md b/Portuguese-README.md deleted file mode 100644 index a239827..0000000 --- a/Portuguese-README.md +++ /dev/null @@ -1,3 +0,0 @@ -# jogos-santa-casa-api - -Um REST API para consultar as chave dos Ășltimos sorteio dos jogos Santacasa. diff --git a/README.md b/README.md index 28fa8b8..e7261b5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # jogos-santa-casa-api A REST API to check the keys for the latest draws of Jogos Santacasa. + +## Project scope + +This project was created with the scope of learning how to web scrape using JavaScript/TypeScript, by using the Cheerios library. Used to also practice creating a REST API. + +The project can be expanded upon in order to cover the other lottery tickets, however, as this was a practice project, I do not see how repeating the same process for the others would benefit me or my learning path. That said, feel free to fork it, use and expand it to your needs. + +## Dependencies + +- [Node.js](https://nodejs.org/) Used to run JS +- Packages listed in package.json + - Axios: HTTP requests library + - Cheerios: Used for web scraping + - Express: Used to create the web server