Api created to get images of a website through the url.
About the project | Technologies | Getting started | How to contribute | License
This project aims to provide an api, which through any url will change the page informed by downloading your images in a local folder, and saving their links in a mongodb bank.
Technologies that I used to develop this api
Import the Insomnia.json
on Insomnia App or click on Run in Insomnia button
Obs.: I recommend use docker
Clone the project and access the folder
$ git clone https://github.com/Raphaenn/webScraping-Typescript-puppeteer && cd webScraping-Typescript
Follow the steps below
# Install the dependencies
$ yarn
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env
# Create the instance of mongoDB using docker
$ docker run --name myname-mongodb -p 27017:27017 -d -t mongo
# Make a copy of 'ormconfig.example.json' to 'ormconfig.json'
# and set the values, if they are not filled,
# to connect with docker database containers
$ cp ormconfig.example.json ormconfig.json
# To finish, run the api service
$ yarn dev:run
# Well done, project is started!
Make a fork of this repository
# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork Raphaenn/webScraping-Typescript-puppeteer
Follow the steps below
# Clone your fork
$ git clone your-fork-url && cd webScraping-Typescript
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new feature'
# Send the code to your remote branch
$ git push origin my-feature
After your pull request is merged, you can delete your branch
This project is licensed under the MIT License - see the LICENSE file for details.
Made with 💙 by Raphael Neves 👋 See my linkedin