Git Product home page Git Product logo

quacs's Introduction

QuACS - The Questionably Accurate Course Scheduler

View the live version here: https://quacs.org

Join the development discord! You can view QuACS at https://quacs.org

Want to help with development? Join the development discord!

What are people saying?

quacs do be lookin pretty fresh tho — Former YACS Project Manager

"Best thing since sliced bread" — Chris Jerrett

plz dont quote me — @quacs duck@quacs duck

QuACS Philosophy

  • Course Scheduling is not that complex and can be done in the user's browser. QuACS will always be a simple static website on GitHub pages.
  • QuACS should be accessible to everyone. If you have an accessibility issue, please let us know and we will try our best to fix it.
  • Mobile phones should not be second class citizens. Do not hide important data from people on mobile devices.
  • Open Source. Everything in QuACS is open source under the MIT License.
  • Competition drives innovation. We love competition because we feel that everyone is better off because of it. Our data is not only publicly stored in this repo, but it also is easy to acquire yourself using our scrapers. We would love to see what people can do with the data!
  • Your privacy is extremely important. We do not track website visits and, because everything is client side, you can rest assured that nothing you upload or do on QuACS is viewable by anyone else.

Other Notes

While QuACS and the developers are huge fans of RCOS, we are not affiliated with RCOS at this time. If you want to help out with development, join our Discord server.

We are also not affiliated with YACS. The work they have done has been invaluable to the RPI student body and while our codebase is different, much of our design was inspired by YACS. We however also support competition and believe we provide a number of features that YACS does not. We are hoping you try us out when you register for classes next semester.

Development info

Project setup

yarn install

You'll also need to install Rust and wasm-pack to build the WebAssembly components of the website. Instructions for installing wasm-pack can be found here.

Compiles and hot-reloads for development

yarn serve

Lints and fixes files

yarn lint

Contributing a theme

Please replace dark with your theme name

  1. Make a copy of src/assets/styles/colors.css into the themes folder with the name dark.css
  2. Import your theme in src/main.ts using import "@/assets/styles/themes/dark.css";
  3. Replace :root { on line 1 in the new css file with [data-theme="dark"] {
  4. Go to src/components/Settings.vue and add your theme to themeOptions in the format { value: "dark", text: "Dark" },
  5. Edit the colors in your new css file and when you are ready, make a pull request!

Redeploy GitHub Pages

  1. Generate a github token with the repo scope. Learn More
  2. Run this curl command with your token
curl -H "Accept: application/vnd.github.everest-preview+json" \
    -H "Authorization: token <your-token-here>" \
    --request POST \
    --data '{"event_type": "deploy"}' \
    https://api.github.com/repos/quacs/quacs/dispatches

quacs's People

Contributors

benjaminrsherman avatar dependabot-preview[bot] avatar dependabot[bot] avatar elihschiff avatar johnnyapol avatar williamjallen 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.