Coder Social home page Coder Social logo

r6-api-scraper's Introduction

Netlify Status

Rainbow Six Siege API

To learn more about the Rainbow Six Siege API, read the docs.

Repository Structure

SDK

The source for the SDK can be found in the lib directory. It's fairly simple, and a full explanation can be found in the docs.

Docs

The source for the docs site exists in the website directory. It is built daily on Netlify and deployed to r6.elviswolcott.com.

The docs content lives in website/src/pages as React components and in website/docs as Markdown. The site is built using Docusaurus 2 and configured in website/docusaurus.config.js and website/sidebars.json.

While most of the docs are written by hand, some pages are generated during the manfiest build process. They can be found in website/docs/auto AFTER running a build and will not be tracked in git.

Scraper

The source for the scraper is in the scraper directory. Using puppeteer, it pulls information from various Ubisoft sites to build the manifest and associated documentation pages. It also pulls all of the image assets.

Make sure to create scraper/.env with a UBI_EMAIL, UBI_PASSWORD, and UBI_ID for your account.

The UBI_ID can be found by signing into https://game-rainbow6.ubi.com and will be in the URL in the form `https://game-rainbow6.ubi.com/en-us/{PLATFORM}/player-statistics/{UBI_ID}/multiplayer

Contributing

Contributions are welcome!

Create an issue or open a PR to if there's something you want added to the docs or SDK.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.