millie
/
jogos-santa-casa-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Amelia 2022-06-06 15:18:59 +01:00
parent 1f8929e8e7
commit f94bf587a9
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Portuguese-README.md
View File

@ -1,3 +0,0 @@
# jogos-santa-casa-api
Um REST API para consultar as chave dos últimos sorteio dos jogos Santacasa.

14
README.md
View File

@ -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