Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added product features and autolabcli and modified mkdocs accordingly #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/Autolabclireadme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AutoLab CLI #

[![Code Climate](https://codeclimate.com/github/prasadtalasila/autolabcli/badges/gpa.svg)](https://codeclimate.com/github/prasadtalasila/autolabcli) [![Known Vulnerabilities](https://snyk.io/test/github/autolabjs/autolabcli/badge.svg)](https://snyk.io/test/github/autolabjs/autolabcli) [![Build Status](https://travis-ci.org/AutolabJS/autolabcli.svg?branch=master)](https://travis-ci.org/AutolabJS/autolabcli)

A client command line interface for submissions to [AutolabJS](https://github.com/AutolabJS/AutolabJS).



## Commands ##
* `autolab init` - Initializes local repository and authenticates
* `autolab exit` - Wipes off the credentials from the system
* `autolab git create` - Creates a repository on Gitlab
* `autolab git delete` - Deletes the specified repository from Gitlab
* `autolab git changeserver` - To change the host of the gitlab server
* `autolab git changelang` - To change the language of the code submission
* `autolab git push` - Adds, commits, pushes the code
* `autolab submit` - To submit the code to JavaAutolab and fetch the results
* `autolab exit` - Print help manual


## Installation ##
```
npm install -g autolabcli
```

## Screenshot ##
![autolab-screenshot](https://cloud.githubusercontent.com/assets/13795788/21156451/e1d7cf04-c19b-11e6-9174-593ab68be76a.png)

## License ##
GNU General Public License
25 changes: 25 additions & 0 deletions docs/Product-Features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
A summary of project features are:

1. Auto-evaluation support for programming labs.
1. Support for multiple languages. The languages supported are: C, C++, Java, Python.
1. Automated score board listing maximum marks for each of students.
1. Uses Gitlab to provide *git* version control to students.
1. Uses Docker containers to separate the Autolab components.
1. Support for unit / integration / functional and Input-Output testing strategies.
1. Ansible-based auto configuration and installation procedure.
1. <s>On demand auto re-evaluation for instructors.</s> (this feature needs bug fixing)


Screenshots
-----------
A few screenshots of the project.

### Main page ###
![Main Page](images/main_page.png)

### Evaluation Request ###
![Evaluation Request] (images/evaluation_request.png)

### Scoreboard ###
![Scoreboard](images/scoreboard.png)

2 changes: 1 addition & 1 deletion docs/autolabcli.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* [AutolabCLI](https://github.com/AutolabJS/autolabcli)
Link to AutolabCLI - [AutolabCLI](https://github.com/AutolabJS/autolabcli)
10 changes: 7 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,13 @@ pages:
- Input-Output (IO) tests using :
- Source code : 'AutolabJS v0.2.0/v0.2.0-IO-Tests.md'
- Compiled binaries : 'AutolabJS v0.2.0/v0.2.0-IO-Tests-Binaries.md'
- Post lab self evaluation : 'AutolabJS v0.2.0/v0.2.0-Post-lab-self-evaluation.md'
- AutloabJS Coding Standards : 'AutolabJS-coding-standards.md'
- AutolabCLI: 'autolabcli.md'
- Post lab self evaluation : 'AutolabJS v0.2.0/v0.2.0-Post-lab-self-evaluation.md'
- Product Features : 'Product-Features.md'

- Coding Standards : 'AutolabJS-coding-standards.md'
- AutolabCLI:
- Home : 'autolabcli.md'
- Student Tutorial : 'Autolabclireadme.md'
- Documentation: 'docs.md'
- AutolabWebsite: 'website.md'
extra:
Expand Down