search

yohann-kevin / scrapysneake

🤖 Scrapysneake the scrapping bot for stb
1 stars 0 forks source link

readme

ScrapySneake

[![Maintainability](https://api.codeclimate.com/v1/badges/9ba129739085df10b469/maintainability)](https://codeclimate.com/github/yohann-kevin/scrapysneake/maintainability) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/6264da9a819e451583acf72453bfbf13)](https://www.codacy.com/gh/yohann-kevin/scrapysneake/dashboard?utm_source=github.com&utm_medium=referral&utm_content=yohann-kevin/scrapysneake&utm_campaign=Badge_Grade) [![CircleCI](https://circleci.com/gh/yohann-kevin/scrapysneake.svg?style=svg)](https://circleci.com/gh/yohann-kevin/scrapysneake) [![Ruby](https://img.shields.io/badge/language-ruby-red)](https://img.shields.io/badge/language-ruby-red) [![GitHub issues](https://img.shields.io/github/issues/yohann-kevin/scrapysneake?style=plastic)](https://github.com/yohann-kevin/scrapysneake/issues) [![Known Vulnerabilities](https://snyk.io/test/github/yohann-kevin/scrapysneake/badge.svg)](https://snyk.io/test/github/yohann-kevin/scrapysneake) [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

scrapysneake the scraping bot for the sneake yourself well site. this site

This platform is a price comparison for sneakers. Eventually, the platform will set up an API to retrieve all sneaker data.

Technology

How to install this project

in order to install the project start by cloning the repository

git clone https://github.com/yohann-kevin/scrapysneake.git
cd scrappysneake

then it will be necessary to install all the dependencies

bundle install

once the dependencies are installed, you will have to configure the local database in the database.yml.

default: &default
  adapter: sqlite3
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000

development:
  <<: *default
  database: db/dev.db

test:
  <<: *default
  database: db/test.sqlite3

production:
  adapter: mysql2
  url: <%= ENV['DATABASE_URL'] %>

Load the schema into the new database.

rails db:schema:load

and finally start this project

rails server

if everything is working well you can go to http://localhost:3000 and you should have this kind of response in json format.

{
  "response": "Welcome to scrappysneake !"
}

This response is normal the "/" path by default does not return any data but if the above message is displayed it means that the API is working correctly.

How to contribute

To contribute to the scrappysneake API project please follow the instructions in CONTRIBUTING.md .

If the back and ruby is not your strong point you can always contribute to the improvement of the front part, the code of which is also available on github. STB front.

Found a bug? Report it on GitHub Issues and include a code sample ! This is vitally important.

Contributor