studyjourney/codedatasurvey

Study Journey Data Survey

Help us making YOUR Study Journey at Code easier!
Contribute your data »

Chat with us at Slack

About the Project
- Built With
Getting Started
- Prerequisites
- Installation
LP GraphQL Queries
Database Structure
License

About The Project

Data Survey Screen Shot

The Study Journey Project wants to help you passing code modules easier. The first step of our project is to gain more knowledge on the current situation. This will help us to provide resources and methods more meaningful for everyone.

Our key principles for this project:

Only fetch data we actually need
Be transparent about the data we fetch.
Anonymize all data and remove any connection to a specific person

To achieve this goal we decided to build a small Express Web App, that takes your Code Learning Platform API Token. We then fetch some data that gets anonymized and then stored to a Database for later evaluation.

Down below you'll find an indepth description on how and what we will query the LP.

Built With

The Survey App is Build using the following technologies

Getting Started

If you want to run the project on your local machine, follow the following Description.

Prerequisites

node v14.X The base app is made to run on node version 14.X. Download here
npm All necessary npm modules can be installed by running the following command inside the directory
```
npm install
```
MySQL Gathered data will be saved to a standard MySQL Database. The base Template can be found here

Installation

Clone the repository

git clone https://github.com/studyjourney/codedatasurvey.git

Install NPM dependencies
```
npm install
```
Import the db.sql file into the MySQL Database
Rename .env.sample to .env Enter the DB Credentials to your MySQL Database
Run the app
```
npm start
```
Open the app at localhost:3000

Data Accessed at Code

Main MyStudies Query codeLearningPlatform.js

    const query = `query {
        myStudies {
            shortCode  # eg SE_36_Fall_2019. We don't need this but I think it's good to have in case we can't work with the semesterModule id later
            assessments {
                assessmentStatus  # present, absent, etc
                assessmentStyle  # standard, alternative, etc
                examinationForms  # oral, written, etc
                proposalText
                grade
                assessmentProtocol
                internalNotes
                externalFeedback
                attempt
                earlyAssessmentProposal
                assessmentType  # normal, reassessment, level up, etc
                ${getProjects ? `project {
                    id
                }` : ''}
                semesterModule {
                    id
                }
            }
        }
    }`

Database Structure

To store the data a MySQL DB is being used. Diagram of MySQL: Database Model

License

TBD Distributed under the . See LICENSE for more information.