Skip to content
/ docs Public

Welcome to Yacs. We're happy to see you ❤️

License

Notifications You must be signed in to change notification settings

YACS-RCOS/docs

Repository files navigation

Welcome to Yacs!

It's so good to see you!

What is Yacs?

Yacs was created with the goal of making students' lives a little easier. It allows users to avoid the clunky UIs of proprietary Catalog Management and Student Information Systems, replacing these unpleasant experiences with easy browsing and searching of courses, and adds the additional functionality of easy schedule generation, and much more.

But Yacs has grown to be much more than a simple schedule generator. Our mission at Yacs is the following:

  1. To alleviate the stress around academic and extracurricular planning for Students, Faculty and Staff by offering a free, easy-to-use interface to supplement or replace traditional academic information and management systems.
  1. To enable innovative, disruptive applications in the academic space by breaking down proprietary information silos and providing consistent, digestible, Open Data.
  1. To empower students to take control of their academic experience and excel their careers through learning about and contributing to Open Source.

Further, Yacs aims to provide the best experience possible to as many people as possible by serving as many universities as we can. Yacs is built from the ground up to be modular and flexible, and as such can use data from any source, and even combine data from many sources in an intelligent way.

We have made it as easy as possible to connect Yacs to your university, and have designed this process to be accessible to developers of nearly any skill level. Please read through this documentation or contact us if you'd like to bring Yacs to your school, and help us make Yacs as great as it can be.

Yacs owes its creation and continued maintenance to RCOS, the Rensselaer Center for Open Source, and is developed in collaboration with BUGS, NYU's Open Source Club.

About this site

This site is the home of (nearly) all Yacs documentation. Like all Yacs projects, this documentation is free and open source, and lives in our Github.

How to Read These Docs

The Yacs documentation is divided into several sections. Each section and its purpose is described here.

Overview

Start Here! This section contains the about page, which explains what Yacs is, why it exists, where we are, and where we plan to go. This section also contains the Code of Conduct. By participating in the Yacs community, you are agreeing to follow the Code of Conduct. Understanding and following the Code of Conduct is extremely important for the health and success of the project, its contributors, and the Yacs community.

Contributing

Look here if you want to contribute to Yacs, run the software on your machine, or just play around with the source. Here you will find installation instructions, project management information, and tips on how and where to get started.

Architecture

Here you will find the nitty-gritty details about how Yacs works. This is a useful resource if you are looking to tackle a larger issue, or want to work towards bringing Yacs to your university.

User Guides

This section contains user guides specific to each of the roles that use yacs. This section is currenrly under construction.

API Docs

Yacs has a public API! This API can be used to build all sorts of interesting, useful, or silly applications using the power of open data. If you have an idea for something to build using the Yacs API, or are looking for inspiration, we'd love to hear from you!

Afterword

Yacs is an open, safe community, and this site is a living document. So please treat it as such! If you find these docs to be insufficient, or you think you can do better, by all means let us know or open a pull request. We encourage contributions from all, no matter how big or small.

When people help us to feel good about who we are, they are helping us love the meaning of what we create in this life - Mr. Rogers

About

Welcome to Yacs. We're happy to see you ❤️

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published