From dfaab6135f5b7723df2afcf3bc52134a0e7082e7 Mon Sep 17 00:00:00 2001 From: "Achim D. Brucker" Date: Sat, 11 Aug 2018 09:07:16 +0100 Subject: [PATCH] Added brief description of the Grade Management system. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index df0772f..afef43d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ -# Installation +# Grade Management - An Intentionally Vulnerable Rails Application + +Grade Management is an **intentionally vulnerable** grade management application that can +be used for teaching *security testing* and *security programming*. + +Grade Management implements a simplistic system for managaing university grade, i.e., students +can check their marks and academics can enter marks. + +## Installation Make sure that you have `ruby` and `ruby-bundler` installed. Then, run the following in the grademgmt directory: -``` +```bash bundle install --path vendor/bundle ``` -# Starting the server +## Starting the server To start the development server, run the following: -``` +```bash bin/rails server ```