Wiki

The CS198 API is a JSON API built with Ruby on Rails. It provides all the data necessary for CS198 frontend web applications to run, abstracting away the databases as a clean, RESTful API.

$ rails server

This runs tests and lint, to ensure that your code meets quality standards. This does not, however, check if you have written tests in the first place!

$ rake

To run tests or lint in isolation, do:

$ rake test
$ rake lint

We'd love to have you work with us; working on these tools really improves the section leader program, and may provide you with valuable experience doing web software engineering.

We rely on git and Ruby on Rails to run this system, so if you're not familiar with those tools then getting familiar with them would be valuable. Any contributions you make here will be code-reviewed, so if you're unsure if you're ready just contribute and we'll tell you how to improve!

• Pro-git covers everything you need to know about git; I recommend going through most of this book.
• Rails Guides is a good place to start learning about how Rails works.

• Set up your development environment
• Try out the API
• When you're ready to push, we use the Github PR workflow to manage contributions.

Thanks for your continued support!