feat: quiz doctypes

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
   pull_request: {}
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     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,22 +53,19 @@ jobs:
         then
            (cd && tar xzf ~/bench-cache/bench.tgz)
         else
-          bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)"
+          bench init ~/frappe-bench --skip-redis-config-generation
           mkdir -p ~/bench-cache
           (cd && tar czf ~/bench-cache/bench.tgz frappe-bench)
         fi
-    - name: add school app to bench
+    - name: add community app to bench
       working-directory: /home/runner/frappe-bench
-      run: bench get-app school $GITHUB_WORKSPACE
+      run: bench get-app community $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 school app
+    - name: install community app
       working-directory: /home/runner/frappe-bench
-      run: bench --verbose --site frappe.local install-app school
-    - name: setup requirements
-      working-directory: /home/runner/frappe-bench
-      run: bench setup requirements --dev
+      run: bench --verbose --site frappe.local install-app community
     - name: allow tests
       working-directory: /home/runner/frappe-bench
       run: bench --site frappe.local set-config allow_tests true
@@ -77,5 +74,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 school
+      run: bench --site frappe.local run-tests --app community
 

.gitignore

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

Contribution.md

@@ -1,7 +0,0 @@
-
-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 school *.css
-recursive-include school *.csv
-recursive-include school *.html
-recursive-include school *.ico
-recursive-include school *.js
-recursive-include school *.json
-recursive-include school *.md
-recursive-include school *.png
-recursive-include school *.py
-recursive-include school *.svg
-recursive-include school *.txt
-recursive-exclude school *.pyc
+recursive-include community *.css
+recursive-include community *.csv
+recursive-include community *.html
+recursive-include community *.ico
+recursive-include community *.js
+recursive-include community *.json
+recursive-include community *.md
+recursive-include community *.png
+recursive-include community *.py
+recursive-include community *.svg
+recursive-include community *.txt
+recursive-exclude community *.pyc

README.md

@@ -1,25 +1,79 @@
-## School
+## Community
 
-Create online courses without much hassle.
+This app helps people organize and manage their own communities.
 
-![Course Home](/school/public/images/course-home.png)
+The App has following components:
 
-## Features
+1. Hackathons
+1. LMS
 
-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.
+Community is built on the [Frappe Framework](https://github.com/frappe/frappe), a full-stack web app framework built with Python & JavaScript.
 
 ## Development Setup
 
-1. [Through Docker](docker-installation.md)
-1. [Direct install through bench](bench-installation.md)
+**Step 1:** Clone the repo
 
+```
+$ git clone https://github.com/fossunited/community.git
 
-### Contributing
+$ cd community
+```
 
-1. [Contribution Guidelines](Contribution.md)
+**Step 2:** Run docker-compose
 
-## License
+```
+$ docker-compose up
+```
 
-[GNU AFFERO GENERAL PUBLIC LICENSE](license.txt)
+**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
+```
+
+## 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/docs 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

@@ -1,10 +0,0 @@
-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/widgets/Avatar.html

@@ -1,5 +1,5 @@
 {% set color = member.get_palette() %}
-<a class="button-links" href="{{ get_profile_url(member.username) }}">
+<a href="/{{member.username}}">
   <span class="avatar {{ avatar_class }}" title="{{ member.full_name }}">
     {% if member.user_image %}
     <img class="avatar-frame standard-image" style="object-fit: cover;" src="{{ member.user_image }}" title="{{ member.full_name }}">

community/hackathon/README.md

@@ -1,6 +1,6 @@
 The Hackathon module allows Community Members to organize and manage hackathons. Community Members can view these hackathons on the portal.
 
-<img class="screenshot" src="/school/hackathon/images/hackathons-portal.png">
+<img class="screenshot" src="/community/hackathon/images/hackathons-portal.png">
 
 ### Key Features:
 
@@ -9,7 +9,7 @@ The Hackathon module allows Community Members to organize and manage hackathons.
 1. Hackathons can be created using the **Community Hackathon** doctype.
 1. Enter the hackathon name, the organizer, the year and Save.
 
-<img class="screenshot" src="/school/hackathon/images/community-hackathon.png">
+<img class="screenshot" src="/community/hackathon/images/community-hackathon.png">
 
 ##### Projects
 
@@ -20,16 +20,16 @@ The Hackathon module allows Community Members to organize and manage hackathons.
 1. Attach important links like Repository Link, Demo Link, Telegram Id.
 1. The checkbox Accepting Members can be used if you are still aceepting members for your project.
 
-<img class="screenshot" src="/school/hackathon/images/project-1.png">
-<img class="screenshot" src="/school/hackathon/images/project-2.png">
+<img class="screenshot" src="/community/hackathon/images/project-1.png">
+<img class="screenshot" src="/community/hackathon/images/project-2.png">
 
 1. Projects are visible on the portal as well.
-<img class="screenshot" src="/school/hackathon/images/project-portal.png">
-<img class="screenshot" src="/school/hackathon/images/project-details.png">
+<img class="screenshot" src="/community/hackathon/images/project-portal.png">
+<img class="screenshot" src="/community/hackathon/images/project-details.png">
 
 ##### Project Members
 
 1. Community Members can explore the projects of hackathons and decide if they want to join any project.
 1. If the project is accepting members they can apply for the project from the web form available on the portal.
-<img class="screenshot" src="/school/hackathon/images/project-join-request.png">
+<img class="screenshot" src="/community/hackathon/images/project-join-request.png">
 1. Project owners can review the requests and accept/reject the members.