Tintin is a TypeScript project designed to scrape specific websites for certain content and send email notifications with the findings. This service runs automatically every day at 6 PM using the Node.js node-cron
package. It utilizes various libraries such as nodemailer
, firebase
, and axios
to accomplish its tasks.
To run this project locally, make sure you have the following prerequisites installed:
- Node.js: Download and Install Node.js
- TypeScript: Install TypeScript globally by running
npm install -g typescript
Follow these steps to set up the Tintin project on your local machine:
-
Clone the repository:
git clone https://github.com/Rubalaine/tintin.git
-
Navigate to the project directory:
cd tintin
-
Install the dependencies:
yarn install
-
Configure the project:
- Create a new
.env
file on root folder based on the.example.env
- Create a new
-
Run the project:
yarn dev
To start the Tintin service, run the following command:
yarn start
The service will run every day at 6 PM and scrape the specified websites for the desired content. Once the content is found, an email notification will be sent to the provided recipient email address.
Contributions to Tintin are always welcome. If you find any bugs, have suggestions, or want to
add new features, please open an issue or submit a pull request on the GitHub repository.
This project is licensed under the MIT License.