tunapanda / wikonnect Goto Github PK

Write documentation for Swag/Wikonnect based on all features to date.

As a developer, I would like continuous deployment to be set up so that new versions can be deployed without requiring additional input.
Related to #32

• Work with GitHub and CircleCI to push successful builds to a staging server for user testing.
• Also push stable versions to production identified with GitHub tags

As a frontend developer, I would like a foundation to work off.

• Ember CLI init an octane app
• Add sass
• Configure adapter & serializer to work with API

As a user, I'd like to be able to navigate to the main features of the app on mobile and desktop

Logged In Menu Items

• Home

• My Courses

• Profile

• Logout

• Settings

• About

Guest Menu Items

• Home

• Courses

• Login

• Sign Up

• About

As a user, I would like to visit modules and see their content.

• Basic Template and styling
• Any interaction
• Test interaction

As a frontend engineer, I would like ember models to be able to interact with the API effectively.

• Decide on and create models mapping to the API

Match home page template to design team specs.

As a developer, I would like to be able to cache objects to improve performance.

• I like Redis, but explore other options
• Find a library and/or create a caching API for use in the app
• Implement caching using the API

As a developer, I would like a permission system so that not everyone can CRUD everything.

• Basic end-user permissions, users can only edit their own profile/settings and update resources that they own (activity/enrollments/achievements).
• Content creator role/group who are able to create paths/courses/modules/lessons/chapters and edit their own ones
• administrator role/group that can "do everything" including modifying content and users.

As a user, I would like to be able to search and find any topic/subtopic/course/chapter.

• Basic Template and styling
• Input with a dropdown showing results
• Full results page
• Test interaction

As a frontend engineer, I would like to be able to query the API using query params.

• Create a way to query the API via any attribute

• Some attributes may need to be prevented from querying, depending on authorisation/permissions

• Test the querying

• Eager/related queries should return only id and type

Adding content to homepage

As a user, I would like to see an overview of topics from the homepage.

• Show summary of topics and subtopics
• Test interaction

As a user, I'd like to be able to see my profile, with details about my learning progress.

• Profile page
• Test Page

• Lesson page

• Add h5p action

• Label h5p properties with form validation

• Display all h5p content

As a user, I would like to visit lessons and see their content.

• Basic Template and styling
• Any interaction
• Test interaction

Include nested queries

• Chapters

• Courses

• Learning paths

• Users

• Authentications

• Modules

• Achievements

• Activities

As a user, I'd like a landing page to tell me about Wikonnect

• Create Page from Designs
• Test if needed

As a developer, I would like a dockerize application for streamlined deployments.

• Docker containers for: frontend/static/nginx, API, database, elasticsearch, redis(?)
• Docker compose to get it all working
• Research Kubernetes

As a user, I would like to be able to search everything.
As a frontend engineer, I would like to be able to search everything via the API.

• Configure ElasticSearch index
• Use queries to create an API endpoint for search
• Test the search API endpoint
• Design search queries
• Index things when they are inserted into the database
• Update the index when things are updated

Modify templates to match design specs

• Create module page that allows for the addition of lessons

• Create course page that allows for the addition of lessons

Integrate CircleCI with Elasticsearch

Modify templates to match design specs

As a front-end developer, I would like to have a standard set of UI components to have a uniform look and feel.

• Buttons

• Typography

• Colors

• Form Elements

• Navigation

• Feedback / Alerts

• Dialogs/Modals

• Empty States

• Cards

• Lists / SubLists

• Tabs

• Tables

• Icons

• Documentation

Using Storybook Js to showcase components

Modify templates to match design specs

Modify templates to match design specs

• Display uploaded h5p content in app

• Store basic achievements on completion

As a frontend engineer, I would like a reusable component to display a chapter within a course.

• Template and styling
• Integrate H5P seemlessly into ember
• record/emit/save xAPI statements/progress
• Test interaction

As a frontend engineer, I would like to be able to authenticate with the API.

• Username/Email & password Authentication Route(s) with Bcrypt that provides a JWT
• Validation for authentication routes
• JWT middleware to maintain session
• A middleware to check if the request is authorized
• Test the endpoints

As a frontend engineer, I would like a reusable component to display lessons in a list.

• Basic Template and styling
• Show status of topic ((in)complete or having (in)complete dependencies)
• Optionally show chapters of topic and their completion status
• Any interaction
• Test interaction

As a frontend engineer, I would like a style foundation to work with

• Decide on a framework like Bootstrap/Bulma etc. if needed
• Implement general styles for elements like headings, links, buttons, forms etc from designs.
• Add the header and logo
• Add the footer

Modify templates to match design specs

As a developer, I would like a permission system so that not everyone can CRUD everything.

• A way to query permissions so that the frontend can inform users of their capabilities(return an array with permissions objects)
• jwt exception for the login(users) and signup(auth) route- [ ] content manager role/group which adds managing others' content to the content creator.
• tests for the access control system

The tests will account for 3 types of users(basic, admin, super admin)
With permissions around edit, delete, read, and update a course and a module

As an engineer, I would like a database with a logical structure to store the relational data for Wikonnect.

• Knex migrations

As a user, I would like to be able to login to the app.

• Login and registration pages
• Login and registration form components
• Login and registration form validation
• Comunicate with API for Authentication and Authorization using ember-simple-auth & ember-simple-auth-token
• A service to manage and maintain sessions
• Test login and registration form

Depends on #6

As a frontend engineer, I would like all the routes/pages/screens mapped out according to the designs.

As a user, I would like to visit a course and complete the chapters within it.

• Basic Template and styling
• Any interaction
• Test interaction

• Set up hosting

• Landing page at wikonnect.org

• App at ???.wikonnect.org

Code the wikonnect home page

DESIGN

REPO

As a frontend engineer, I would like to be able to post data to a route and save part of the data in a join table model

• Create a way to save join table data sent from the front end (POST and PUT)
• Test the saving of data

Match home page template to design team specs.

• Upload and unzip h5p content

• Store properties in the correct database

• Chapter/Lesson/Module/Course completion status

As a backend engineer, I would like a foundation to work on.

• Koa.js server
• Router
• Logger
• Error handler
• Database connection

There are new security fixes that have been made on dependencies that are in use in the project.

One or more other dependencies require a version that is incompatible with these updates making this **not a high priority issue **

yarn outdated will show a list of updated dependencies and meta information on the upgrade version

As a user, I'd like to be able to change details about myself and update preferences

• My account
• Preferences
• Integration Test

As a frontend engineer, I would like CRUD endpoints for the Ember app to communicate with.

• Decide on all the endpoints needed, should more or less map to the database
• Flesh out the basic models and routes using Koa.js and objection.js
  Depends on #1

Modify templates to match design specs

As a frontend engineer, I would like a reusable component to display modules in a list.

• Edit Template and styling
• Any interaction
• Test interaction