Giter VIP home page Giter VIP logo

wcaregs's Introduction

WCA-Regs

WCA-Regs Compiles regulations and guidelines together to render them on the same searchable page.

Netlify Status

Design

The main focus of this website is converting the regulations and guidelines from markdown to json. This is a script that we run manually and it spits the json into ./src/assets/regulationsAndGuidelines.json. This is so that we can easily programatically render the markdown contents of the git submodule. Regulations only really change 1-2 times a year so this just has to be maintained occasionally.

Setup

Because this repo includes the wca-regulations as a submodule, we have to clone it differently than normal:

git clone --recursive [email protected]:coder13/wcaregs.git

If you cloned it and forgot to grab the submodule:

git submodule update --init

You then install the node modules:

yarn install

The regulations json will not be included so you must build it to keep with the most up-to-date regs.

yarn regsAndGuides

And then start up the dev server:

yarn start

This project was bootstraped with create-react-app so further help can be found in their docs.

Update

Whenever new regulations are released, clone repo, and do git submodule update --remote, then commit and push.

wcaregs's People

Contributors

coder13 avatar dependabot[bot] avatar

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.