Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/autolab/Autolab

Course management service that enables auto-graded programming assignments.
https://github.com/autolab/Autolab

autograding autolab cmu education feedback programming rails scoreboard students teaching

Last synced: about 2 months ago
JSON representation

Course management service that enables auto-graded programming assignments.

Awesome Lists containing this project

README 

        


  




Autolab is a course management service, initially developed by a team of students at Carnegie Mellon University, that enables instructors to offer autograded programming assignments to their students over the Web. The two key ideas in Autolab are *autograding*, that is, programs evaluating other programs, and *scoreboards*.



Autolab also provides other services that instructors expect in a course management system, including gradebooks, rosters, handins/handouts, lab writeups, code annotation, manual grading, late penalties, grace days, cheat checking, meetings, partners, and bulk emails.



Since 2010, Autolab has had a transformative impact on education at CMU. Each semester, it is used by about 5,000 CMU students in courses in Pittsburgh, Silicon Valley, Qatar, and Rwanda. In Fall, 2014, we are releasing Autolab as an open-source system, where it will be available to schools all over the world, and hopefully have the same impact it's had at CMU.







  






  






 






[![Build Status](http://autolab-d01.club.cc.cmu.edu:8080/buildStatus/icon?job=autolab+demosite)](http://autolab-d01.club.cc.cmu.edu:8080/job/autolab%20demosite/)

[![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/95ro.svg)](https://betteruptime.com/?utm_source=status_badge)

![GitHub last commit](https://img.shields.io/github/last-commit/autolab/Autolab)



Subscribe to our [mailing list](https://groups.google.com/g/autolabproject) to receive announcements about major releases and updates to the Autolab Project.



## Try It Out

We have a demo site running at https://nightly.autolabproject.com/. See the [docs](https://docs.autolabproject.com/#demonstration-site) for more information on how to log in and suggestions on things to try.



## Installation



We released new documentation! Check it out [here](https://docs.autolabproject.com).



## Testing



### Setting up Tests



1. Add a test database in `database.yml`



2. Create and migrate the database.

	```sh

	RAILS_ENV=test bundle exec rails autolab:setup_test_env

	```

   Do not forget to use `RAILS_ENV=test bundle exec` in front of every rake/rails command.



3. Create necessary directories.



	```

	mkdir tmp/

	```



### Running Tests



After setting up the test environment, simply run spec by:



```sh

bundle exec rails spec

```



You may need to run `RAILS_ENV=test bundle exec rails autolab:setup_test_env` when re-running tests as some tests

may create models in the database.



You can also run individual spec files by running:



```sh

rake spec SPEC=./spec//.rb

```



## Rails 5 Support

Autolab is now running on Rails 6. The Rails 5 branch can be found on `master-rails-5`. 

We will not be backporting any new features from `master` to `master-rails-5`, and we have discontinued Rails 5 support.



## Updating Docs

To install mkdocs, run

```bash

pip install --user mkdocs

```



We rely on the `mkdocs-material` theme, which can be installed with

```bash

pip install --user mkdocs-material

```



To run and preview this locally, run:



```bash

mkdocs serve

```



Once your updated documentation is in `master`, Jenkins will automatically run a job to update the docs. You can trigger a manual update with



```bash

mkdocs gh-deploy

```



This will build the site using the branch you are currently in (hopefully `master`), place the built HTML files into the `gh-pages` branch, and push them to GitHub. GitHub will then automatically deploy the new content in `gh-pages`.



## Contributing



We encourage you to contribute to Autolab! Please check out the

[Contributing to Autolab Guide](https://github.com/autolab/Autolab/blob/master/CONTRIBUTING.md) for guidelines about how to proceed. You can reach out to us on [Slack](https://communityinviter.com/apps/autolab/autolab-project) as well.



## License



Autolab is released under the [Apache License 2.0](http://opensource.org/licenses/Apache-2.0).



## Using Autolab



Please feel free to use Autolab at your school/organization. If you run into any problems, you can reach the core developers at `[email protected]` and we would be happy to help. On a case-by-case basis, we also provide servers for free. (Especially if you are an NGO or small high-school classroom)



## Changelog

### [v2.12.0](https://github.com/autolab/Autolab/releases/tag/v2.12.0) (2024/01/20) Attachment categories and visual cues

- Ruby upgraded to 3.2.2

- Rails upgraded to 6.1.7.6

- Instructors can now specify a category and "release at" date for attachments

- Assessment start / end dates are now shown on course homepages



### [v2.11.0](https://github.com/autolab/Autolab/releases/tag/v2.11.0) (2023/05/21) LTI Settings UI, extensions metrics, and simultaneous extension creation

- Introduced UI to manage LTI integration settings

- Added extension metrics for instructors to monitor students by number of extensions granted

- Instructors can now create extensions for multiple students at once



### [v2.10.0](https://github.com/autolab/Autolab/releases/tag/v2.10.0) (2023/01/13) LTI Integration, Generalized Feedback, and Streaming Output

- Autolab now supports roster syncing with courses on Canvas and other LTI (Learning Tools Interoperability) services. For full instructions on setup, see the documentation.

- Streaming partial output and new feedback interface

- Generalized annotations



**For older releases, please check out the [releases page](https://github.com/autolab/Autolab/releases).**