fix: made course filter mandatory for course progress summary report

The new image of anandology/frappe-bench has the following changes:
- the bench directoy is changed from /home/bench/frappe-bench to /opt/frappe-bench
- dependency on external redis service is removed

Updated the docker-compose.yml to reflect these changes. Also pinned the
docker image to anandology/frappe-bench:2021.10

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
   pull_request: {}
 jobs:
   tests:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     services:
       redis-cache:
         image: redis:alpine
@@ -32,7 +32,7 @@ jobs:
     - name: setup python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.9'
     - name: setup node
       uses: actions/setup-node@v2
       with:
@@ -53,19 +53,22 @@ jobs:
         then
            (cd && tar xzf ~/bench-cache/bench.tgz)
         else
-          bench init ~/frappe-bench --skip-redis-config-generation
+          bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)"
           mkdir -p ~/bench-cache
           (cd && tar czf ~/bench-cache/bench.tgz frappe-bench)
         fi
-    - name: add community app to bench
+    - name: add school app to bench
       working-directory: /home/runner/frappe-bench
-      run: bench get-app community $GITHUB_WORKSPACE
+      run: bench get-app school $GITHUB_WORKSPACE
     - name: create bench site
       working-directory: /home/runner/frappe-bench
       run: bench new-site --mariadb-root-password root --admin-password admin frappe.local
-    - name: install community app
+    - name: install school app
       working-directory: /home/runner/frappe-bench
-      run: bench --verbose --site frappe.local install-app community
+      run: bench --verbose --site frappe.local install-app school
+    - name: setup requirements
+      working-directory: /home/runner/frappe-bench
+      run: bench setup requirements --dev
     - name: allow tests
       working-directory: /home/runner/frappe-bench
       run: bench --site frappe.local set-config allow_tests true
@@ -74,5 +77,5 @@ jobs:
       run: bench --site frappe.local build
     - name: run tests
       working-directory: /home/runner/frappe-bench
-      run: bench --site frappe.local run-tests --app community
+      run: bench --site frappe.local run-tests --app school
 

.gitignore

@@ -3,8 +3,8 @@
 *.egg-info
 *.swp
 tags
-community/docs/current
+school/docs/current
-community/public/dist
+school/public/dist
 __pycache__/
 *.py[cod]
 *$py.class

Contribution.md

@@ -0,0 +1,7 @@
+
+1. Go to the apps/school directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the frappe/school repository on GitHub.
+1. Check out a working branch in git (e.g. git checkout -b my-new-branch).
+1. Make your proposed changes to the source
+1. Run your local version (e.g. bench start in your bench installation). Make sure that your changes work the way you want them to.
+1. Commit your changes to your branch. Make sure to use a semantic commit message.
+1. Push your branch to your fork on Github, and issue a pull request.

MANIFEST.in

@@ -4,15 +4,15 @@ include *.json
 include *.md
 include *.py
 include *.txt
-recursive-include community *.css
+recursive-include school *.css
-recursive-include community *.csv
+recursive-include school *.csv
-recursive-include community *.html
+recursive-include school *.html
-recursive-include community *.ico
+recursive-include school *.ico
-recursive-include community *.js
+recursive-include school *.js
-recursive-include community *.json
+recursive-include school *.json
-recursive-include community *.md
+recursive-include school *.md
-recursive-include community *.png
+recursive-include school *.png
-recursive-include community *.py
+recursive-include school *.py
-recursive-include community *.svg
+recursive-include school *.svg
-recursive-include community *.txt
+recursive-include school *.txt
-recursive-exclude community *.pyc
+recursive-exclude school *.pyc

README.md

@@ -1,79 +1,25 @@
-## Community
+## School
 
-This app helps people organize and manage their own communities.
+Create online courses without much hassle.
 
-The App has following components:
+![Course Home](/school/public/images/course-home.png)
 
-1. Hackathons
+## Features
-1. LMS
 
-Community is built on the [Frappe Framework](https://github.com/frappe/frappe), a full-stack web app framework built with Python & JavaScript.
+1. Simple Backend Forms.
+1. The UI is clean and minimal.
+1. Lessons can be in the form of texts, videos, quizzes or a combination of all of these.
 
 ## Development Setup
 
-**Step 1:** Clone the repo
+1. [Through Docker](docker-installation.md)
+1. [Direct install through bench](bench-installation.md)
 
-```
-$ git clone https://github.com/fossunited/community.git
 
-$ cd community
+### Contributing
-```
 
-**Step 2:** Run docker-compose
+1. [Contribution Guidelines](Contribution.md)
 
-```
+## License
-$ docker-compose up
-```
 
-**Step 3:** Visit the website at http://localhost:8000/
+[GNU AFFERO GENERAL PUBLIC LICENSE](license.txt)
-
-You'll have to go through the setup wizard to setup the website for the first time you access it. Login using the following credentiasl to complete the setup wizard.
-
-```
-Username: Administrator
-password: admin
-```
-
-TODO: Explain how to load sample data
-
-## Stopping the server
-
-Press `ctrl+c` in the terminal to stop the server. You can also run `docker-compose down` in another terminal to stop it.
-
-To completely reset the instance, do the following:
-
-```
-$ docker-compose down --volumes
-$ docker-compose up
-```
-
-## Making Code Changes
-
-The dev setup is configured to reload whenever any code is changed. Just edit the code and reload the webpage.
-
-Commit the changes in a branch and send a pull request.
-
-## Local Setup - The Hard Way
-
-To setup the repository locally follow the steps mentioned below:
-
-1. Install bench and setup a frappe-bench directory by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation).
-1. Start the server by running bench start.
-1. In a separate terminal window, create a new site by running bench new-site community.test.
-1. Run bench get-app https://github.com/fossunited/community.
-1. Run bench --site community.test install-app community.
-1. Map your site to localhost with the command ```bench --site community.test add-to-hosts```
-1. Now open the URL http://community.test:8000/ in your browser, you should see the app running.
-
-### Contribution Guidelines (for The Hard Way)
-
-1. Go to the apps/community directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the fossunited/community repository on GitHub.
-1. Check out a working branch in git (e.g. git checkout -b my-new-branch).
-1. Make your proposed changes to the source
-1. Run your local version (e.g. bench start in your bench installation). Make sure that your changes work the way you want them to.
-1. Commit your changes to your branch. Make sure to use a semantic commit message.
-1. Push your branch to your fork on Github, and issue a pull request.
-
-#### License
-
-AGPL

bench-installation.md

@@ -0,0 +1,10 @@
+To setup the repository locally follow the steps mentioned below:
+
+1. Install bench and setup a frappe-bench directory by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation).
+1. Start the server by running bench start.
+1. In a separate terminal window, create a new site by running bench new-site school.test.
+1. Fork the school app
+1. Run bench get-app <url-of-your-form>.
+1. Run bench --site school.test install-app school.
+1. Map your site to localhost with the command ```bench --site school.test add-to-hosts```
+1. Now open the URL http://school.test:8000/ in your browser, you should see the app running.

community/community/doctype/discussion_reply/discussion_reply.js

@@ -1,8 +0,0 @@
-// Copyright (c) 2021, FOSS United and contributors
-// For license information, please see license.txt
-
-frappe.ui.form.on('Discussion Reply', {
-	// refresh: function(frm) {
-
-	// }
-});

community/community/doctype/discussion_reply/discussion_reply.json

@@ -1,51 +0,0 @@
-{
- "actions": [],
- "creation": "2021-08-11 10:59:38.597046",
- "doctype": "DocType",
- "editable_grid": 1,
- "engine": "InnoDB",
- "field_order": [
-  "topic",
-  "reply"
- ],
- "fields": [
-  {
-   "fieldname": "reply",
-   "fieldtype": "Long Text",
-   "in_list_view": 1,
-   "label": "Reply"
-  },
-  {
-   "fieldname": "topic",
-   "fieldtype": "Link",
-   "in_list_view": 1,
-   "in_standard_filter": 1,
-   "label": "Topic",
-   "options": "Discussion Topic"
-  }
- ],
- "index_web_pages_for_search": 1,
- "links": [],
- "modified": "2021-08-27 15:06:51.362714",
- "modified_by": "Administrator",
- "module": "Community",
- "name": "Discussion Reply",
- "owner": "Administrator",
- "permissions": [
-  {
-   "create": 1,
-   "delete": 1,
-   "email": 1,
-   "export": 1,
-   "print": 1,
-   "read": 1,
-   "report": 1,
-   "role": "System Manager",
-   "share": 1,
-   "write": 1
-  }
- ],
- "sort_field": "modified",
- "sort_order": "DESC",
- "track_changes": 1
-}

community/community/doctype/discussion_reply/discussion_reply.py

@@ -1,29 +0,0 @@
-# Copyright (c) 2021, FOSS United and contributors
-# For license information, please see license.txt
-
-import frappe
-from frappe.model.document import Document
-from community.widgets import Widgets
-
-class DiscussionReply(Document):
-    def after_insert(self):
-        data = {
-            "reply": self,
-            "topic": {
-                "name": self.topic
-            },
-            "widgets": Widgets()
-        }
-        template = frappe.render_template("community/templates/discussions/reply_card.html", data)
-        topic_info = frappe.get_all("Discussion Topic", {"name": self.topic}, ["reference_doctype", "reference_docname", "name", "title", "owner", "creation"])
-        sidebar = frappe.render_template("community/templates/discussions/sidebar.html", { "topic": topic_info[0], "widgets": Widgets() })
-        new_topic_template = frappe.render_template("community/templates/discussions/reply_section.html", { "topics": topic_info, "widgets": Widgets() })
-
-        frappe.publish_realtime(event="publish_message",
-                                message = {
-                                    "template": template,
-                                    "topic_info": topic_info[0],
-                                    "sidebar": sidebar,
-                                    "new_topic_template": new_topic_template
-                                },
-                                after_commit=True)

community/community/doctype/discussion_topic/discussion_topic.js

@@ -1,8 +0,0 @@
-// Copyright (c) 2021, FOSS United and contributors
-// For license information, please see license.txt
-
-frappe.ui.form.on('Discussion Topic', {
-	// refresh: function(frm) {
-
-	// }
-});

community/community/doctype/discussion_topic/discussion_topic.json

@@ -1,57 +0,0 @@
-{
- "actions": [],
- "creation": "2021-08-11 10:55:29.341674",
- "doctype": "DocType",
- "editable_grid": 1,
- "engine": "InnoDB",
- "field_order": [
-  "title",
-  "reference_doctype",
-  "reference_docname"
- ],
- "fields": [
-  {
-   "fieldname": "title",
-   "fieldtype": "Data",
-   "label": "Title"
-  },
-  {
-   "fieldname": "reference_doctype",
-   "fieldtype": "Link",
-   "label": "Reference Doctype",
-   "options": "DocType"
-  },
-  {
-   "fieldname": "reference_docname",
-   "fieldtype": "Dynamic Link",
-   "label": "Reference Docname",
-   "options": "reference_doctype"
-  }
- ],
- "index_web_pages_for_search": 1,
- "links": [],
- "modified": "2021-08-11 12:29:43.564123",
- "modified_by": "Administrator",
- "module": "Community",
- "name": "Discussion Topic",
- "owner": "Administrator",
- "permissions": [
-  {
-   "create": 1,
-   "delete": 1,
-   "email": 1,
-   "export": 1,
-   "print": 1,
-   "read": 1,
-   "report": 1,
-   "role": "System Manager",
-   "share": 1,
-   "write": 1
-  }
- ],
- "search_fields": "title",
- "sort_field": "modified",
- "sort_order": "DESC",
- "title_field": "title",
- "track_changes": 1
-}

community/community/doctype/discussion_topic/discussion_topic.py

@@ -1,35 +0,0 @@
-# Copyright (c) 2021, FOSS United and contributors
-# For license information, please see license.txt
-
-import frappe
-from frappe.model.document import Document
-
-class DiscussionTopic(Document):
-    pass
-
-@frappe.whitelist()
-def submit_discussion(doctype, docname, reply, title, topic_name=None):
-    if topic_name:
-        save_message(reply, topic_name)
-        return topic_name
-
-    topic = frappe.get_doc({
-                "doctype": "Discussion Topic",
-                "title": title,
-                "reference_doctype": doctype,
-                "reference_docname": docname
-            })
-    topic.save(ignore_permissions=True)
-    save_message(reply, topic.name)
-    return topic.name
-
-def save_message(reply, topic):
-    frappe.get_doc({
-        "doctype": "Discussion Reply",
-        "reply": reply,
-        "topic": topic
-    }).save(ignore_permissions=True)
-
-@frappe.whitelist()
-def get_docname(route):
-    return frappe.db.get_value("Web Page", {"route": route}, ["name"])

community/community/web_template/discussions/discussions.html

@@ -1,2 +0,0 @@
-{% set docname = frappe.db.get_value("Web Page", {"route": ""}, ["name"])%}
-{{ widgets.DiscussionMessage(doctype="Web Page", docname=docname) }}

community/community/widgets/CommentBox.html

@@ -1,28 +0,0 @@
-<form class="discussion-form">
-
-  <div class="form-group">
-    <div class="control-input-wrapper">
-      <div class="control-input">
-        <input type="text" autocomplete="off" class="input-with-feedback form-control topic-title" data-fieldtype="Data"
-          data-fieldname="feedback_comments" placeholder="Title" spellcheck="false"></input>
-      </div>
-    </div>
-  </div>
-
-  <div class="form-group">
-    <div class="control-input-wrapper">
-      <div class="control-input">
-        <textarea type="text" autocomplete="off" class="input-with-feedback form-control comment-field"
-          data-fieldtype="Text" data-fieldname="feedback_comments" placeholder="Enter a comment..."
-          spellcheck="false"></textarea>
-      </div>
-    </div>
-  </div>
-
-  <div class="comment-footer">
-    <div class="button is-default pull-right mb-5 submit-discussion" data-doctype="{{ doctype | urlencode }}"
-      data-docname="{{ docname | urlencode }}">
-      Post</div>
-  </div>
-
-</form>

community/community/widgets/DiscussionMessage.html

@@ -1,54 +0,0 @@
-{% set topics = frappe.get_all("Discussion Topic",
-{"reference_doctype": doctype, "reference_docname": docname}, ["name", "title", "owner", "creation"]) %}
-
-{% include "community/templates/discussions/topic_modal.html" %}
-
-<div class="discussions-parent">
-  <div class="discussions-header">
-    <span class="course-home-headings">{{_('Discussions')}}</span>
-    {% if topics %}
-    {% include "community/templates/discussions/button.html" %}
-    {% endif %}
-  </div>
-
-  {% if topics %}
-  <div class="common-card-style thread-card course-content-parent" data-doctype="{{ doctype }}"
-    data-docname="{{ docname }}">
-
-    <div class="discussions-sidebar">
-      {% include "community/templates/discussions/search.html" %}
-      {% for topic in topics %}
-      {% set replies = frappe.get_all("Discussion Reply", {"topic": topic.name})%}
-      {% include "community/templates/discussions/sidebar.html" %}
-      {% endfor %}
-    </div>
-
-    <div class="mr-2" id="discussion-group">
-      {% include "community/templates/discussions/reply_section.html" %}
-    </div>
-  </div>
-  {% else %}
-
-  <div id="no-discussions" class="common-card-style thread-card">
-    <div class="no-discussions">
-      <div class="font-weight-bold">No Discussions</div>
-      <div class="muted-text mt-3 mb-3">There are no discussions for this {{ doctype | lower }}, why don't you start
-        one! </div>
-      {% if frappe.session.user == "Guest" %}
-      <div class="button is-primary mt-3" id="login-from-discussion">Log In</div>
-      {% elif not condition %}
-      <div class="button is-primary mt-3" id="login-from-discussion" data-redirect="{{ redirect_to }}">
-        {{ button_name }}
-      </div>
-      {% else %}
-      {% include "community/templates/discussions/button.html" %}
-      {% endif %}
-    </div>
-  </div>
-</div>
-{% endif %}
-</div>
-
-{% block script %}
-<script>{% include "community/templates/discussions/discussions.js" %}</script>
-{% endblock %}

community/lms/doctype/chapter/test_chapter.py

@@ -1,10 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021, FOSS United and Contributors
-# See license.txt
-from __future__ import unicode_literals
-
-# import frappe
-import unittest
-
-class TestChapter(unittest.TestCase):
-	pass

community/lms/doctype/lesson/test_lesson.py

@@ -1,10 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021, FOSS United and Contributors
-# See license.txt
-from __future__ import unicode_literals
-
-# import frappe
-import unittest
-
-class TestLesson(unittest.TestCase):
-	pass

community/lms/widgets/BatchHeader.html

@@ -1,4 +0,0 @@
-<div class="p-5 batch-header">
-  <h3>{{batch_name}}</h3>
-  <div class="text-muted">{{member_count}} members</div>
-</div>

community/lms/widgets/BreadCrumb.html

@@ -1,21 +0,0 @@
-<div class="breadcrumb">
-
-
-  {% if course %}
-  <a class="dark-links" href="/courses">All Courses</a>
-  <img class="ml-1 mr-1" src="/assets/community/icons/chevron-right.svg">
-  {% if lesson %}
-  <a class="dark-links" href="/courses/{{ course.name }}">{{ course.title }}</a>
-  <img class="ml-1 mr-1" src="/assets/community/icons/chevron-right.svg">
-  <span class="muted-text"> {{ lesson.title }}</span>
-  {% else %}
-  <span class="muted-text">{{ course.title }}</span>
-  {% endif %}
-  {% endif %}
-
-  {% if thread %}
-  <a class="dark-links" href="/discussions">Discussions</a>
-  <img class="ml-1 mr-1" src="/assets/community/icons/chevron-right.svg">
-  <span class="muted-text">{{ thread.title }}</span>
-  {% endif %}
-</div>

community/lms/widgets/CourseCard.html

@@ -1,90 +0,0 @@
-<div class="common-card-style course-card">
-  <div class="course-image {% if not course.image %}default-image{% endif %}"
-    {% if course.image %} style="background-image: url( {{ course.image }} );" {% endif %}>
-    <div class="course-tags">
-      {% for tag in course.get_tags() %}
-      <div class="course-card-pills">{{ tag }}</div>
-      {% endfor %}
-    </div>
-    {% if not course.image %}
-    <div class="default-image-text">{{ course.title[0] }}</div>
-    {% endif %}
-  </div>
-  <div class="course-card-content">
-    <div class="course-card-meta muted-text">
-      {% if course.get_chapters() | length %}
-      <span>
-        {{ course.get_chapters() | length }} Chapters
-      </span>
-      {% endif %}
-      {% if course.get_chapters() | length and course.get_upcoming_batches() | length %}
-      <span class="font-weight-bold ml-3 mr-3"> . </span>
-      {% endif %}
-      {% if course.get_upcoming_batches() | length %}
-      <span class="">
-        {{ course.get_upcoming_batches() | length }} Open Batches
-      </span>
-      {% endif %}
-    </div>
-    <div class="course-card-title">{{ course.title }}</div>
-    <div class="card-divider"></div>
-    <div class="course-card-meta-2">
-      {{ widgets.Avatar(member=course.get_instructor(), avatar_class="avatar-small") }}
-      <span class="course-instructor">
-        {{ course.get_instructor().full_name }}
-      </span>
-      <span class="course-student-count">
-        {% if course.get_students() | length %}
-        <span class="mr-4">
-          <img class="icon-background" src="/assets/community/icons/user.svg" />
-          {{ course.get_students() | length }}
-        </span>
-        {% endif %}
-        {% set avg_rating = course.get_average_rating() %}
-        {% if avg_rating %}
-        <span>
-          <img class="icon-background" src="/assets/community/icons/rating.svg" />
-          {{ avg_rating }}
-        </span>
-        {% endif %}
-      </span>
-    </div>
-    {% set membership = course.get_membership(frappe.session.user) %}
-
-    {% set lesson_index = course.get_lesson_index(membership.current_lesson) if membership and
-    membership.current_lesson
-    else '1.1' %}
-
-    {% set query_parameter = "?batch=" + membership.batch if membership and membership.batch else "" %}
-
-    {% if course.upcoming %}
-    <div class="view-course-link is-secondary border">
-      Upcoming Course <img class="ml-3" src="/assets/community/icons/black-arrow.svg" />
-    </div>
-    <a class="stretched-link" href="/courses/{{ course.name }}"></a>
-
-    {% elif membership %}
-    <div class="view-course-link is-primary">
-      Continue Course <img class="ml-3" src="/assets/community/icons/white-arrow.svg" />
-    </div>
-    <a class="stretched-link" href="{{ course.get_learn_url(lesson_index) }}{{ query_parameter }}"></a>
-
-    {% else %}
-    <div class="view-course-link is-default">
-      View Course <img class="ml-3" src="/assets/community/icons/black-arrow.svg" />
-    </div>
-    <a class="stretched-link" href="/courses/{{ course.name }}"></a>
-
-    {% endif %}
-  </div>
-</div>
-<script>
-  frappe.ready(() => {
-    $(".course-card-title").each((i, element) => {
-      var title = $(element).text();
-      var length = $(window).width() <= 375 ? 60 : 65;
-      var suffix = title.length > length ? "..." : "";
-      $(element).text(title.substring(0, length) + suffix);
-    })
-  })
-</script>

community/lms/widgets/InstructorSection.html

@@ -1,6 +0,0 @@
-<div class="instructor">
-  {{ widgets.Avatar(member=instructor, avatar_class="avatar-medium") }}
-  <a class="ml-1 instructor-title" href="{{get_profile_url(instructor.username)}}">{{ instructor.full_name }}</a>
-  <div class="instructor-subtitle">Course Creator</div>
-  <!-- <div class="instructor-subtitle">Created {{instructor.get_course_count()}} courses</div> -->
-</div>

community/templates/certificate.html

@@ -1,37 +0,0 @@
-<div class="common-card-style">
-  <div class="certificate-content">
-    <div class="certificate-heading">
-      Certificate of Completion
-    </div>
-    <div class="certificate-para">
-      This is to certify that <span class="font-weight-bold">{{ student.full_name }}</span> has successfully completed
-      <span class="font-weight-bold">{{ course.title }}</span> online course on
-      <span class="font-weight-bold">{{ frappe.utils.format_date(certificate.issue_date, "medium") }}</span>
-    </div>
-    <div class="certificate-footer">
-      {% if instructor %}
-      <div>
-        <span>
-          Instructor:
-        </span>
-        <span class="font-weight-bold">
-          {{ instructor.full_name }}
-        </span>
-      </div>
-      {% endif %}
-      {% if certificate.expiry_date %}
-      <div>
-        <span>
-          Expiry Date:
-        </span>
-        <span class="font-weight-bold">
-          {{ frappe.utils.format_date(certificate.expiry_date, "medium") }}
-        </span>
-      </div>
-      {% endif %}
-    </div>
-    <img src="{{ logo }}" class="certificate-logo">
-  </div>
-  <div class="certificate-ribbon"></div>
-</div>
-<script src="/assets/community/js/html2canvas.js"></script>

community/templates/discussions/button.html

@@ -1,7 +0,0 @@
-{% if frappe.session.user != "Guest" and
-(condition is not defined or (condition is defined and condition )) %}
-<span class="button is-secondary reply">
-  New Discussion
-  <img src="/assets/community/icons/small-add-black.svg">
-</span>
-{% endif %}

community/templates/discussions/discussions.js

@@ -1,198 +0,0 @@
-frappe.ready(() => {
-  setup_socket_io();
-
-  set_docname_if_missing();
-
-  expand_first_discussion();
-
-  $(".search-field").keyup((e) => {
-    search_topic(e);
-  });
-
-  $(".reply").click((e) => {
-    show_new_topic_modal(e);
-  });
-
-  $("#login-from-discussion").click((e) => {
-    login_from_discussion(e);
-  });
-
-  $(".sidebar-topic").click((e) => {
-    if ($(e.currentTarget).attr("aria-expanded") == "true") {
-      e.stopPropagation();
-    }
-  });
-
-  $(document).on("click", ".submit-discussion", (e) => {
-    submit_discussion(e);
-  });
-})
-
-var show_new_topic_modal = (e) => {
-  e.preventDefault();
-  $("#discussion-modal").modal("show");
-  var topic = $(e.currentTarget).attr("data-topic");
-  $(".modal-headings").text(topic ? "Reply" : "Start a Discussion");
-  topic ? $(".topic-title").addClass("hide") : $(".topic-title").removeClass("hide");
-  $("#submit-discussion").attr("data-topic", topic ? topic : "");
-}
-
-var setup_socket_io = () => {
-  const assets = [
-    "/assets/frappe/js/lib/socket.io.min.js",
-    "/assets/frappe/js/frappe/socketio_client.js",
-  ]
-
-  frappe.require(assets, () => {
-    if (window.dev_server) {
-      frappe.boot.socketio_port = "9000";
-    }
-    frappe.socketio.init(9000);
-    frappe.socketio.socket.on("publish_message", (data) => {
-      publish_message(data);
-    })
-  })
-}
-
-var publish_message = (data) => {
-  post_message_cleanup();
-
-  if ($(`.discussion-on-page[data-topic=${data.topic_info.name}]`).length) {
-    if ($(`.discussion-on-page[data-topic=${data.topic_info.name}] .card-divider-dark`).length) {
-      $(data.template).insertAfter(`.discussion-on-page[data-topic=${data.topic_info.name}] .card-divider-dark`);
-    }
-    else {
-
-      $('<div class="card-divider-dark mb-10"></div>' + data.template).insertAfter(`.discussion-on-page[data-topic=${data.topic_info.name}] .discussion-form`);
-    }
-  }
-  else if ((decodeURIComponent($(".discussions-parent .course-content-parent").attr("data-doctype")) == data.topic_info.reference_doctype
-    && decodeURIComponent($(".discussions-parent .course-content-parent").attr("data-docname")) == data.topic_info.reference_docname)) {
-    $(data.sidebar).insertAfter(`.discussions-sidebar .form-group`);
-    $(`#discussion-group`).prepend(data.new_topic_template);
-
-    if (data.topic_info.owner == frappe.session.user) {
-      $(".discussion-on-page").collapse();
-      $(".sidebar-topic").first().click();
-    }
-
-  }
-  else {
-    window.location.reload();
-  }
-
-  update_reply_count(data.topic_info.name);
-}
-
-var post_message_cleanup = () => {
-  $(".comment-field").val("");
-  $("#discussion-modal").modal("hide");
-  $("#no-discussions").addClass("hide");
-}
-
-var update_reply_count = (topic) => {
-  var reply_count = $(`[data-target='#t${topic}']`).find(".reply-count").text();
-  reply_count = parseInt(reply_count) + 1;
-  $(`[data-target='#t${topic}']`).find(".reply-count").text(reply_count);
-}
-
-var set_docname_if_missing = () => {
-  if ($("[data-docname='None']").length) {
-    frappe.call({
-      method: "community.community.doctype.discussion_topic.discussion_topic.get_docname",
-      args: {
-        "route": window.location.href.split("/").slice(-1)[0]
-      },
-      callback: (data) => {
-        $("[data-docname='None']").attr("data-docname", data.message);
-      }
-    })
-  }
-}
-
-var expand_first_discussion = () => {
-  $($(".discussions-parent .collapse")[0]).addClass("show");
-  $($(".discussions-sidebar [data-toggle='collapse']")[0]).attr("aria-expanded", true);
-}
-
-var search_topic = (e) => {
-  var input = $(e.currentTarget).val();
-
-  var topics = $(".discussions-parent .discussion-topic-title");
-  if (input.length < 3 || input.trim() == "") {
-    topics.closest(".sidebar-parent").removeClass("hide");
-    return
-  }
-
-  topics.each((i, elem) => {
-    var topic_id = $(elem).parent().attr("data-target");
-
-    /* Check match in replies */
-    var match_in_reply = false;
-    var replies = $(`${topic_id}`);
-    for (var reply of replies.find(".reply-text")) {
-      if (has_common_substring($(reply).text(), input)) {
-        match_in_reply = true;
-        break;
-      }
-    }
-
-    /* Match found in title or replies, then show */
-    if (has_common_substring($(elem).text(), input) || match_in_reply) {
-      $(elem).closest(".sidebar-parent").removeClass("hide")
-    }
-    else {
-      $(elem).closest(".sidebar-parent").addClass("hide");
-    }
-
-  })
-}
-
-var has_common_substring = (str1, str2) => {
-  var str1_arr = str1.toLowerCase().split(" ");
-  var str2_arr = str2.toLowerCase().split(" ");
-
-  var substring_found = false;
-  for (var first_word of str1_arr) {
-    for (var second_word of str2_arr) {
-      if (first_word.indexOf(second_word) > -1) {
-        substring_found = true;
-        break;
-      }
-    }
-  }
-  return substring_found;
-}
-
-var submit_discussion = (e) => {
-  e.preventDefault();
-  e.stopImmediatePropagation();
-
-  var title = $(".topic-title:visible").length ? $(".topic-title:visible").val().trim() : "";
-  var reply = $(".comment-field:visible").val().trim();
-
-  if (reply) {
-    var doctype = $(e.currentTarget).attr("data-doctype");
-    doctype = doctype ? decodeURIComponent(doctype) : doctype;
-
-    var docname = $(e.currentTarget).attr("data-docname");
-    docname = docname ? decodeURIComponent(docname) : docname;
-
-    frappe.call({
-      method: "community.community.doctype.discussion_topic.discussion_topic.submit_discussion",
-      args: {
-        "doctype": doctype ? doctype : "",
-        "docname": docname ? docname : "",
-        "reply": reply,
-        "title": title,
-        "topic_name": $(e.currentTarget).closest(".discussion-on-page").attr("data-topic")
-      }
-    })
-
-  }
-}
-
-var login_from_discussion = (e) => {
-  var redirect = $(e.currentTarget).attr("data-redirect") || window.location.href;
-  window.location.href = `/login?redirect-to=${redirect}`;
-}

community/templates/discussions/reply_card.html

@@ -1,13 +0,0 @@
-<div class="reply-card">
-  {% set member = frappe.get_doc("User", reply.owner) %}
-  <div class="d-flex align-items-center muted-text">
-    {% set member = frappe.get_doc("User", reply.owner) %}
-    {{ widgets.Avatar(member=member, avatar_class="avatar-small")}}
-    <a class="button-links ml-2" href="{{ get_profile_url(member.username) }}">
-      {{ member.full_name }}
-    </a>
-    <div class="ml-2 frappe-timestamp" data-timestamp="{{ reply.creation }}"> just now </div>
-  </div>
-  <div class="card-divider mt-3"></div>
-  <div class="reply-text">{{ reply.reply }}</div>
-</div>

community/templates/discussions/reply_section.html

@@ -1,41 +0,0 @@
-{% for topic in topics %}
-{% set replies = frappe.get_all("Discussion Reply", {"topic": topic.name},
-["reply", "owner", "creation"], order_by="creation desc")%}
-
-<!-- Hack to reorganize the replies array. So even though we want reverse cronology, the first reply should appear first. -->
-{% if replies.insert(0, replies.pop()) %}{% endif %}
-
-{% if replies %}
-<div class="collapse discussion-on-page" id="t{{ topic.name }}" data-topic="{{ topic.name }}"
-  data-parent="#discussion-group">
-  <div class="course-home-headings p-0">{{ topic.title }}</div>
-  {% for reply in replies %}
-
-  {% if loop.index == 2 %}
-  <div class="card-divider-dark mb-10"></div>
-  {% endif %}
-
-  {% include "community/templates/discussions/reply_card.html" %}
-
-  {% if loop.index == 1 %}
-
-  {% if frappe.session.user == "Guest" or (condition is defined and not condition) %}
-  <div class="d-flex flex-column align-items-center muted-text">
-    Want to join the discussion?
-    {% if frappe.session.user == "Guest" %}
-    <div class="button is-primary mt-3 mb-3" id="login-from-discussion">Log In</div>
-    {% elif not condition %}
-    <div class="button is-primary mt-3 mb-3" id="login-from-discussion" data-redirect="{{ redirect_to }}">{{ button_name }}
-    </div>
-    {% endif %}
-  </div>
-  {% else %}
-  {{ widgets.CommentBox(doctype=doctype, docname=docname) }}
-  {% endif %}
-
-  {% endif %}
-
-  {% endfor %}
-</div>
-{% endif %}
-{% endfor %}

community/templates/discussions/search.html

@@ -1,9 +0,0 @@
-<div class="form-group">
-  <div class="control-input-wrapper">
-    <div class="control-input">
-      <textarea type="text" autocomplete="off" class="input-with-feedback form-control search-field"
-        data-fieldtype="Text" data-fieldname="feedback_comments" placeholder="Search Topics"
-        spellcheck="false"></textarea>
-    </div>
-  </div>
-</div>

community/templates/discussions/sidebar.html

@@ -1,20 +0,0 @@
-<div class="sidebar-parent">
-  <div class="sidebar-topic" data-target="#t{{ topic.name }}" data-toggle="collapse" aria-expanded="false">
-    <div class="discussion-topic-title">{{ topic.title }}</div>
-    <div class="mt-2 mb-3">
-      {% set creator = frappe.get_doc("User", topic.owner) %}
-      {{ widgets.Avatar(member=creator, avatar_class="avatar-small") }}
-      <span class="course-instructor">
-        {{ creator.full_name }}
-      </span>
-      <span class="muted-text pull-right">
-        <span class="mr-2">
-          <img src="/assets/community/icons/message.svg">
-          <span class="reply-count">{{ replies | length }}</span>
-        </span>
-        <span> {{ frappe.utils.format_date(topic.creation, "dd MMM YYYY") }} </span>
-      </span>
-    </div>
-  </div>
-  <div class="card-divider"></div>
-</div>

community/templates/discussions/topic_modal.html

@@ -1,15 +0,0 @@
-<div class="modal fade discussion-modal" id="discussion-modal" tabindex="-1" role="dialog" aria-hidden="true">
-  <div class="modal-dialog" role="document">
-    <div class="modal-content">
-      <div class="modal-header">
-        <div class="course-home-headings modal-headings">Start a Discussion</div>
-        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
-          <span aria-hidden="true">&times;</span>
-        </button>
-      </div>
-      <div class="modal-body">
-        {{ widgets.CommentBox(doctype=doctype, docname=docname) }}
-      </div>
-    </div>
-  </div>
-</div>

community/templates/message.html

@@ -1,13 +0,0 @@
-<div class="discussion {% if message.is_author %} is-author {% endif %}">
-  <div class="d-flex justify-content-between">
-    <div class="font-weight-bold">
-      {{ message.author_name }}
-    </div>
-    <div class="text-muted">
-      {{ message.message_time }}
-    </div>
-  </div>
-  <div class="mt-5">
-    {{ message.message }}
-  </div>
-</div>

community/www/courses/index.html

@@ -1,22 +0,0 @@
-{% extends "templates/base.html" %}
-{% from "www/hackathons/macros/card.html" import null_card %}
-{% block title %}{{ 'Courses' }}{% endblock %}
-{% block head_include %}
-<style>
-</style>
-{% endblock %}
-
-{% block content %}
-<div class="common-page-style">
-  <div class="container">
-    <div class="courses-header">
-      {{ 'All Courses' }}
-    </div>
-    <div class="cards-parent">
-      {% for course in courses %}
-      {{ widgets.CourseCard(course=course) }}
-      {% endfor %}
-    </div>
-  </div>
-</div>
-{% endblock %}

community/www/courses/index.py

@@ -1,18 +0,0 @@
-import frappe
-
-def get_context(context):
-    context.no_cache = 1
-    context.courses = get_courses()
-    context.metatags = {
-        "title": "All Courses",
-        "image": frappe.db.get_single_value("Website Settings", "banner_image"),
-        "description": "This page lists all the courses published on our website",
-        "keywords": "All Courses, Courses, Learn"
-    }
-
-def get_courses():
-    course_names = frappe.get_all("LMS Course", filters={"is_published": True}, pluck="name")
-    courses = []
-    for course in course_names:
-        courses.append(frappe.get_doc("LMS Course", course))
-    return courses

docker-compose.yml

@@ -1,12 +1,6 @@
 version: "3"
 
 services:
-  redis-cache:
-    image: redis:alpine
-  redis-queue:
-    image: redis:alpine
-  redis-socketio:
-    image: redis:alpine
   mariadb:
     image: mariadb
     volumes:
@@ -15,18 +9,15 @@ services:
       - MYSQL_ROOT_PASSWORD=root
     command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
   bench:
-    image: anandology/frappe-bench
+    image: anandology/frappe-bench:2021.10
     volumes:
-      - .:/home/bench/frappe-bench/apps/community
+      - .:/opt/frappe-bench/apps/school
     environment:
-      - FRAPPE_APPS=community
+      - FRAPPE_APPS=school
       - FRAPPE_ALLOW_TESTS=true
       - FRAPPE_SITE_NAME=frappe.localhost
     depends_on:
       - mariadb
-      - redis-cache
-      - redis-queue
-      - redis-socketio
     ports:
       - 8000:8000
       - 9000:9000

docker-installation.md

@@ -0,0 +1,35 @@
+**Step 1:** Clone the repo
+
+```
+$ git clone https://github.com/frappe/school.git
+
+$ cd school
+```
+
+**Step 2:** Run docker-compose
+
+```
+$ docker-compose up
+```
+
+**Step 3:** Visit the website at http://localhost:8000/
+
+You'll have to go through the setup wizard to setup the website for the first time you access it. Login using the following credentiasl to complete the setup wizard.
+
+```
+Username: Administrator
+password: admin
+```
+
+TODO: Explain how to load sample data
+
+## Stopping the server
+
+Press `ctrl+c` in the terminal to stop the server. You can also run `docker-compose down` in another terminal to stop it.
+
+To completely reset the instance, do the following:
+
+```
+$ docker-compose down --volumes
+$ docker-compose up
+```

license.txt

@@ -1 +1,661 @@
-License: AGPL
+GNU AFFERO GENERAL PUBLIC LICENSE
+   Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+        Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+   TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+
+The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+The Corresponding Source for a work in source code form is that
+same work.
+
+2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+a) The work must carry prominent notices stating that you modified
+it, and giving a relevant date.
+
+b) The work must carry prominent notices stating that it is
+released under this License and any conditions added under section
+7.  This requirement modifies the requirement in section 4 to
+"keep intact all notices".
+
+c) You must license the entire work, as a whole, under this
+License to anyone who comes into possession of a copy.  This
+License will therefore apply, along with any applicable section 7
+additional terms, to the whole of the work, and all its parts,
+regardless of how they are packaged.  This License gives no
+permission to license the work in any other way, but it does not
+invalidate such permission if you have separately received it.
+
+d) If the work has interactive user interfaces, each must display
+Appropriate Legal Notices; however, if the Program has interactive
+interfaces that do not display Appropriate Legal Notices, your
+work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+a) Convey the object code in, or embodied in, a physical product
+(including a physical distribution medium), accompanied by the
+Corresponding Source fixed on a durable physical medium
+customarily used for software interchange.
+
+b) Convey the object code in, or embodied in, a physical product
+(including a physical distribution medium), accompanied by a
+written offer, valid for at least three years and valid for as
+long as you offer spare parts or customer support for that product
+model, to give anyone who possesses the object code either (1) a
+copy of the Corresponding Source for all the software in the
+product that is covered by this License, on a durable physical
+medium customarily used for software interchange, for a price no
+more than your reasonable cost of physically performing this
+conveying of source, or (2) access to copy the
+Corresponding Source from a network server at no charge.
+
+c) Convey individual copies of the object code with a copy of the
+written offer to provide the Corresponding Source.  This
+alternative is allowed only occasionally and noncommercially, and
+only if you received the object code with such an offer, in accord
+with subsection 6b.
+
+d) Convey the object code by offering access from a designated
+place (gratis or for a charge), and offer equivalent access to the
+Corresponding Source in the same way through the same place at no
+further charge.  You need not require recipients to copy the
+Corresponding Source along with the object code.  If the place to
+copy the object code is a network server, the Corresponding Source
+may be on a different server (operated by you or a third party)
+that supports equivalent copying facilities, provided you maintain
+clear directions next to the object code saying where to find the
+Corresponding Source.  Regardless of what server hosts the
+Corresponding Source, you remain obligated to ensure that it is
+available for as long as needed to satisfy these requirements.
+
+e) Convey the object code using peer-to-peer transmission, provided
+you inform other peers where the object code and Corresponding
+Source of the work are being offered to the general public at no
+charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+a) Disclaiming warranty or limiting liability differently from the
+terms of sections 15 and 16 of this License; or
+
+b) Requiring preservation of specified reasonable legal notices or
+author attributions in that material or in the Appropriate Legal
+Notices displayed by works containing it; or
+
+c) Prohibiting misrepresentation of the origin of that material, or
+requiring that modified versions of such material be marked in
+reasonable ways as different from the original version; or
+
+d) Limiting the use for publicity purposes of names of licensors or
+authors of the material; or
+
+e) Declining to grant rights under trademark law for use of some
+trade names, trademarks, or service marks; or
+
+f) Requiring indemnification of licensors and authors of that
+material by anyone who conveys the material (or modified versions of
+it) with contractual assumptions of liability to the recipient, for
+any liability that these contractual assumptions directly impose on
+those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year>  <name of author>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.