WAD Ruby + Sinatra Assessment 1
Overview
In this assignment you are required to create a Web application resembling a wiki. The wiki is to be designed to invite users to share/edit/update a single Web page on a subject of your choice. This could include providing your own local news page or creating a discussion, and encouraging editing and revision of the topic of interest. Ideas for wiki are list below.
The wiki should cover the following features:
• A single home page containing authentic text details for anyone to view but not edit
• An up-to-date account of the number of words and characters displayed in the text on the home page
• A link to a sign-in page which allows a user to register to edit the wiki
• A log text file which is appended with authorized user and date details each time the wiki is updated.
• A link to a login page which allows only an administrator additional features to perform the following:
• override/remove changes to the details made by a user
• archive the text to a separate backup file
• add/edit/delete user accounts and change their access privileges to edit or not edit the wiki text
• enable the wiki to be reset by the administrator to its initial default text
• A functional layout displaying the wiki application
• Extra marks will be given for additional features such as stylish look and feel
An additional specification document of the wiki is given in the attachment above to illustrate what the wiki might look like. Extra marks will also be available for creativity and innovative design features.
Marking criteria (This is just as a guide)
CGS D: will be awarded where applications provide the simplest functionality, such as covering the above features 1-2 and a report explaining your development.
CGS C: will be awarded where applications provide basic functionality, such as including features 1-2 and 3-4. Note: marks will be lost for not providing authentication details (login/password).
CGS B: will be awarded where applications implement complex functionality, such as containing features 1-4 and 5-6. Note: marks will be lost for not providing details about the existence and use of additional files (i.e., location of file when created).
CGS A: You are required to provide additional features. Note: marks will be lost for not provides details of additional gems, etc, used.
IMPORTANT: marks will be lost for providing no report and/or no screenshots of your web application.
Note: CGS A1 will be awarded if the wiki is deemed to be of a standard eligible for publication on the Web. For this the system should provide all the requested features, contain no spelling / grammatical errors, have an easy to use user interface and contain the appropriate documentation in the report.
What to submit
A single .zip file, containing all the files needed to run your application. The zip file must also include a file manual.pdf containing details of how to install and use your application. It should be a single file and include:
• A description of your wiki web application (Vision).
• System requirements and run instructions (i.e. software to maintain and use the application – including usernames and passwords, additional gems and files).
• A description of the features and functionalities within your application.
• Step by step account explaining how to use the features within the wiki.
• Screenshots illustrating the features and functionalities. Screenshots must be included.
Also note that the readability and structure of your code will be taken into consideration when awarding a final mark for you assignment.
How to submit both parts (a zip file and printed report)
Your zip file containing the wiki application files and manual should be named yourfullname-wadca1.zip (NB: replace yourfullname with your full name) and submitted electronically to the myAberdeen assignment page by selecting the heading ‘WAD Ruby + Sinatra Assessment 1’.
IMPORTANT: only zip files submitted to MyAberdeen will be marked. Zip files emailed to the tutor will not be marked.
Possible wikis
• Collating reviews about a place or location
• Electronic encyclopedia
• Brainstorming application
• Writing application
• Monitoring/tracking/reporting application
• Graffiti wall of words
• Sharing a groups stories/experiences as they travel