https://github.com/sparkeduab/sparked-spec
a design document for the new version of SparkEd
https://github.com/sparkeduab/sparked-spec
design-specification documentation
Last synced: 4 months ago
JSON representation
a design document for the new version of SparkEd
- Host: GitHub
- URL: https://github.com/sparkeduab/sparked-spec
- Owner: SparkEdUAB
- License: mit
- Created: 2019-05-06T08:24:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-26T14:43:30.000Z (almost 7 years ago)
- Last Synced: 2025-08-19T13:41:59.411Z (10 months ago)
- Topics: design-specification, documentation
- Size: 71.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sparked-spec
a design document for SparkEd V3
Graph Representation of how different entities relate to each other.
### Introduction
SparkEd is a software for organizing and presenting educational and training contents for delivery on most platforms.
The current implementation of SparkEd is documented [here](https://sparkeduab.github.io/sparked-manual/) and the source code lives [here](https://github.com/SparkEdUAB/SparkEd).
### Motivation
There are many reasons that made us decide to re-write the SparkEd from scratch, Initially we got feedback from the reviewers at the University of Alabama and there were many issues in version1, we tried to work on most of them but some of the issues were at the core of the code base and this could affect much if we worked on them.
We decided to keep the codebase we had and maintain as we planned to rewrite everything and fix most of the issues.
some of the issues are the following:
- Security
- Perfomance
- Test
- Responsive design
These were the major problems we had that we couldn't address fully
You can read more about other issues [here](https://docs.google.com/document/d/1yZQWqh9KWtOeGHgNknNGzYQCEZku9Ml2vPPExvn4PvA/edit?usp=sharing)
### Goals
As explained in the introduction SparkEd aims to solve the prooblem of content delivery and presentational of educational contents on most platforms and in remote areas.
### Implementation
SparkEd aims to be a platform that accomodates different institutions, this means that it doesn't matter whether you want to use in a school setup or in any organization that has and offers educational contents.
We currently have the following structures:
This is designed for organizations whose contents are divided in higher level hierachy.
**eg:** university has schools then under a specific school there are different programs, then under a program there are courses which has units and topics which have resources.
This is a common implementation in most schools and organizations.
An ideal implementation for High-School(Secondary)
### Terminologies
### Data Model
SparkEd uses MongoDB for Data storage and the following are the structure of different collections.
**Collections**
school
```js
{
_id: String,
name: String,
code: String,
createdAt: Date,
createdBy: String,
}
```
program
```js
{
_id: String
name: String,
code: String,
schoolId: String,
duration: String,
createdAt: Date,
createdBy: String,
}
```
course
```js
{
_id: String
name: String,
code: String,
details: {
schoolId: String,
programId: String,
language: String,
},
createdAt: Date,
createdBy: String,
}
```
units
```js
{
name: String,
topics: Number,
unitDesc: String,
details: {
courseId: String,
programId: String,
language: String,
},
createdAt: Date,
createdBy: String,
}
```
topics
```js
{
unitId: String,
name: String,
unit: String,
resources: Array,
'resources.$': Object,
createdAt: Date,
createdBy: String,
}
```
resources
Resources are basicall file objects that contain information about the files, these are the supported file types
- Videos(`mp4, webm`)
- Pdf(`pdf`)
- Image(`png, jpg, jpeg,`)
- Audio(`mp3, ogg`)
- Text(`txt`)
### Non-Goals
SparkEd is not meant to be a replacement for **Moodle** and this will remain the case, If you want to have a full fledged school management system, you might want consider Moodle or other options.
The following are problems SparkEd doesn't solve
- Discussion or Forum between Instructors and Learners
- Institution or Organization management system
### Milestones
These will correspond with the indicated [milestones here](https://github.com/SparkEdUAB/sparked3.0-spec/milestones) when done
### Existing Solution
The current solution is implemented and named as SparkEd
### Proposed Solution
> We will include new User Interface proposals soon here
### Scoping and Timeline
The project scoping will be included here soon as soon issues are broken down into their specifics
### Impact
### Risks