cvchaparro / les Goto Github PK

As a developer, I want to be able to use a CI server for the project so that, when I make a change to the system, I can have more confidence that it didn't break anything.

AC:

• A CI server (or tool) is set up and ready to be used for the project

As a developer, I want to fix issues experienced on some versions of Google Chrome so that my users can have a consistent user experience on that browser.
AC:

• I shall be able to use the application from Google Chrome

Notes: It seems to work on Chromium, but not on Chrome - this is the peculiar part.

As a developer, I want to create a deployment script (or have some other easy and automated way of deploying my application) so that I don't have to manually deploy after changes are made.
AC:

• I shall have an automated way of updating the deployed application after every code change
• I shall have an easy way of reverting changes, if necessary

As a developer, I want to set up code coverage reporting so that I can see and measure how much I'm testing my code.
AC:

• I shall be able to use Coveralls (using cl-coveralls, probably) to view code coverage reports
• My Travis CI build should provide code coverage data to Coveralls

As a developer, I want to use CL-WHO to generate HTML on the server instead of having to manually write HTML so that I can be more programatic with responding to server requests. (Plus, it means I can use LISP instead of HTML - Yay!)
AC:

• I shall be able to generate web pages with CL-WHO instead of static HTML
• I shall have tests to check for the proper generation of my HTML

As a developer, I want to use Parenscript to generate JavaScript on the server instead of having to manually write JavaScript so that . (Plus, it means I can use LISP instead of JavaScript - Yay!)
AC:

• I shall be able to generate JavaScript instead of static JavaScript
• I shall have tests to check for the proper generation of my JavaScript

As a student, I want to see each question on a separate screen so that I have a clear delineation between one question and another.
AC:

• I shall have the ability to listen to one question and record one answer per screen
• I shall see a button that will take me to the next question

Note: The term screen is purposefully used since it is vague enough to allow for experimentation with different types of front-ends - i.e. different pages, same page but different sections, etc.

As a developer, I want to add tests for the Caveman2 additions so that I can make sure everything is working as expected and, if something breaks, I will have fast feedback about it.
AC:

• I shall have tests for all of the code additions for supporting Caveman2
• I shall have a minimum of 95% code coverage (see code coverage here)

As a developer, I want to evaluate Caveman2 to see if it will satisfy the needs of this project so that I can meet my MVP deadline of 2018-01-31.
AC:

• I shall know if Caveman2 will meet my needs (as follows) for this project:
  • Good learning resources (i.e. tutorials, examples, documentation. etc) for quickly getting something up and running
  • Effective and reliable community support to ensure the project will continue into the future
• I shall be able to use my currently chosen libraries (i.e. cl-who, parenscript, etc) in place of the default libraries with little extra effort
  • This doesn't have to be done in the first phase of setting up Caveman2 for the project, it just has to be possible and documented

As a developer, I want to be able to use a testing framework for my system so that when I make changes to old parts, I can have more confidence that it still works and when I add new things, I can have more confidence that it works as expected.

AC:

• A testing framework is set up and ready to be used for the project

As a teacher, I want to allow the students to answer more than one question so that I can test their ability to follow a conversation.
AC:

• I shall be able to use 3 questions recordings
• Students shall be able to answer all available questions
• Each question should be separated on a different screen (see: #9 for details)

Depends on: #9

As a maintainer, I want to establish a "best practice" approach for the project (as described here) and add contribution guidelines, PR and issue templates, and a code of conduct so that I can streamline future contributions and direct new contributors to these resources when necessary.

AC:

• A Code of Conduct has been defined for the project
• Contribution Guidelines have been defined for the project
• A Pull Request template has been defined for the project
• A New Issue template has been defined for the project
• All files are readily available in the repository

As a student, I want to be able to listen to a recording of a question so that I can answer it.

AC:

• When I select the question, the recording shall be played

As a student, I want to be able to record an answer so that my teacher can listen to it and give me a grade on it.

AC:

• When I select the "Record" button / option / etc, the system shall start a 3 second start timer to give me time to prepare to give my answer
• When the start timer ends, a new recording shall start
• When the recording has started, it shall last for a maximum of 30 seconds
• When the recording ends, I shall have the ability to save it locally