michlee1337 / panorama

Learn concepts at different levels of abstraction and explore relationships between them.

This project is a side project/ experiment.
The objective is as follows:

• support self directed learning via the user journey of figuring out what is the concept you want to learn while searching for resources.
• encourage metacognition by presenting the concept map first and encouraging users to explore/ search in terms of concepts.

See the live website here
Read some unrefined reasonings behind the website here

Searching for resources

• Find resources by concepts, subconcepts, prerequisites, mediatype, and duration.

Exploring related concepts

• Refine search or explore related resources by exploring foundations (prerequisites), alternatives (same concept), or deep dive (expanding on sub concepts).

Filestucture

• Loosely follows MVC
• app initialization can be found in src/__init__.py
• models can be found in src/models
• blueprints can be found in src/blueprints
• templates can be found in src/templates

Prerequisites

Install Python3 Set up Postgresql

• create database and set the appropriate database url (elaborated below) Set up virtual environment
• create virtualenv src
• set DATABASE_URL environment variable
• Start source env/bin/activate

Set up Prerequisites

1. Start virtual enviroment source env/bin/activate
2. Load requirements: pip install -r requirements.txt
3. Run app: python3 src/__init__.py

Dev

To Upload a Dropbox Dump Database to Heroku heroku pg:backups:restore 'https://dl.dropboxusercontent.com/<random string from dropbox link>/<file name>' DATABASE --app panorama-stage

To Update Db flask db migrate -m "comment" flask db upgrade

Test

1. Start virtual env
2. python3 -m unittest discover tests

panorama's Issues

Split up models.py

user testing table

• write up all past user interviews
• write conclusions

fork artifact

• new page pre-populated w old info

edit artifact

• refactor artifact use WTF

• link to chunk form

• update new template

• update create template

• add the CSS back in

• route: render wtfform with object titles, not references

• manually render concept relationships

• create save changes helper func on model to make it cleaner

• save edit route

Suggest Concepts/ Resources based on title

• during create/ edit concept or resource
• search bar

Display concept scaffolds

• view relationships between concepts somehow
• search ^

Compile studyplan based on website x

Code Cleanliness

-[ ] Refactor JS to send nested info properly

Search

• search for studyplans by title
• [] "" resources ""

Refactor artifact models

There should be a way to have global search on a "concept"

gotta consider how i want information to be presented as well

• artifact model

• update create functions

• refactor new js for tag inputs

• refactor new js for chunks only

• html add source and author and metadata

• update search functions

UX

overall

• setup standard

view

• add metadata to content

• fix tabs

• add "breadcrumbs" on chunks

• open prereq search in new tab

• open tabs when open menu

• "diff title" button, otherwise assume title=concept

• allow anonymous creation w prompt to login

• default none selection for metadata

• cmyk text

Refactor Artifact.create()

• JS separate functions
• ensure right send

login UX

• redirect last page
• make it pretty

UX - fine tune

View

• sidebar tabs only appear when sidebar open
• sidebar tabs say what they are on hover
• sidebar tabs: remove weird tab

Create a db seed file

User profile page

• view artifacts you've created
• view artifacts you've starred
• view "forks" on artifacts relevant to you
• view your "goals"/ past progress?

Artifact "common queries"

Traverse studyplans

• Sidebar for search, dim light except relevant area

• find studyplans with this concept

• search prerequisites

• rearrange tabs to be prerequisites, main concept, topics, connections

• find other resources for this concept

• blackout unsearchables

• ajax rqst rel info

• js render

Containerize for local run

Docker

related artifacts - more

• artifacts with the same main concept but different metadata
• artifacts that focus on subtopics covered in the current artifact
• artifacts that focus on prerequisite concepts for the current artifact

Edit studyplan

• edit/ create new copy

Create new resource

Unit Tests

• Travis CI
• test pages
• test artifacts

CI

• pep8 test
• CI setup
• units

index page

• list of studyplans
• blank half of the page for graph view
• login + register/ logout link
• user page link

Setup db migrations

Frontend

Home Page

• view KA
• explain
• add create studyplan links

View Page

• view Forum

Create Page

Fill in Resource metadata

Resources

• difficulty/ estimated time/ source
• voting

Studyplans

• link to external, optional
  ! difficulty will be max, est time will be sum

debug edit

• dont recreate chunk on editttttt
• why is it flashing error
• fix unittesting

Documentation

• make demo vid