Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluette1/web-images-scraper-api

Backend for the waller-photo-slideshow (https://github.com/Bluette1/waller-photo-slideshow) app.
https://github.com/bluette1/web-images-scraper-api

chromedriver rails redis-cache ruby sidekiq sidekiq-cron

Last synced: about 1 month ago
JSON representation

Backend for the waller-photo-slideshow (https://github.com/Bluette1/waller-photo-slideshow) app.

Awesome Lists containing this project

README

        

# web-images-scraper-api

## Built With
- Ruby version 3.1.4
- Rails version 6
- Redis Cache
- Selenium Chrome Driver
- SideKiq

## Description
- Backend for the [ waller-photo-slideshow](https://github.com/Bluette1/waller-photo-slideshow) app.

## Live Demo
[Live Demo](https://web-images-scraper-api-site-fc7f0d9b2e26.herokuapp.com/)

### Run instructions
- Make sure Redis is running, if not type the following commands in the terminal to start the Redis server

`
redis-server --daemonize yes
`
- You can clone the GitHub repo and run the app locally
```
bundle install
rails server
```

### How to use the site
Make sure the server is running
- Go to http://localhost:3000/ in your web browser

- Follow the links on the [waller-photo-slideshow](https://waller-photo-slideshow.netlify.app) to access the available features.

### Setting up env variables
- Set access keys/credentials locally according to the `.env_example` file.

## Deployment
- You can deploy on [Heroku](https://devcenter.heroku.com/categories/ruby-support).
- Make sure you run the following in the terminal for the build:
```
heroku buildpacks:set heroku/ruby
heroku buildpacks:add heroku/chromedriver
heroku buildpacks:add heroku/google-chrome
```
to add the required buildpacks.

- Also remember to scale your dyno formation from the Heroku CLI with the ps:scale command:
`heroku ps:scale worker=1`
## Authors

👤 **Marylene Sawyer**
- Github: [@Bluette1](https://github.com/Bluette1)
- Twitter: [@MaryleneSawyer](https://twitter.com/MaryleneSawyer)
- Linkedin: [Marylene Sawyer](https://www.linkedin.com/in/marylene-sawyer)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Bluette1/web-images-scraper-api/issues).

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](https://opensource.org/licenses/MIT) licensed.