Light

graasp / graasp-app-code-capsule Goto Github PK

View Code? Open in Web Editor NEW

0.0 6.0 0.0 7.31 MB

A Graasp App to perform code reviews, show, annotate and edit code.

License: GNU Affero General Public License v3.0

Shell 0.08% JavaScript 2.47% HTML 0.90% CSS 0.17% TypeScript 96.38%

graasp-app-code-capsule's Introduction

Code Capsule App

This repository hosts the code for a Graasp app that lets users write code reviews, edit and annotate code, alone or in collaboration.

Installation

Running the app

Create a .env.development file with the following content:

VITE_PORT=3005
VITE_API_HOST=http://localhost:3000
VITE_MOCK_API=true
VITE_GRAASP_APP_KEY=45678-677889
VITE_VERSION=latest
# VITE_ENABLE_VERBOSE_MESSAGES=true # comment this out if you want to enable verbose messages

Launch the app with yarn dev.

Running the tests (automatic run on commit with husky)

Create a .env.test file with the following content:

VITE_PORT=3333
VITE_API_HOST=http://localhost:3000
VITE_MOCK_API=true
VITE_GRAASP_APP_KEY=45678-677889
VITE_VERSION=latest
# VITE_ENABLE_VERBOSE_MESSAGES=true # verbose messages will be shown when this is set

# dont open browser
BROWSER=none

Start the tests with yarn test for automatic start of the dev server as well as cypress (similar to the CI run). Or open 2 terminals and execute yarn dev in one and yarn cypress:open in the other. This will open the Cypress GUI app in which you can run individual tests and interact with the app in it's testing environnement.

Documentation

How to bootstrap your app and set every tool you need

Please have a look at the documentation to start your app and setup all necessary tools.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Basile Spaenlehauer

_{Basile Spaenlehauer}
💻 🤔 🔬

This project follows the all-contributors specification. Contributions of any kind welcome!

graasp-app-code-capsule's People

Contributors

Watchers

graasp-app-code-capsule's Issues

Do not reference appSettingId inside other appSetting

When copying an app instance, the settings are copied with it, but the appSetting Ids change.
We use the appSetting Id for files in a setting that lists all files. We should handle our own id inside the data property to be resilient to coping items.

Update Sentry version

all contributors

@all-contributors please add @juancarlosfarah for userTesting, bug, research, ideas.

Update sentry and deps

Implement edit data file button

Use release-please

Add code execution

Tasks:

Create Header and Footer Code Settings
Execute Header + Main + Footer Code on click RUN
Save Student code into an AppData -> captured by #23
Reload Student code from AppData -> captured by #22
Fix tests

Execution environnement is not reset between executions

This can lead to overriding some functions in python and not being able to fix the problem.

For example:

list = 0

And then:

a = list()

Will cause an error because list is not a function anymore.

Save student code as appData on Save

Change bot name to Graasp bot

Refactor how the Instructor works

Instructor code should be a separate setting and its use should be dictated by the AppMode that is currently set.

Repl buttons should collapse to only icons when width is small

Allow saving files in app settings

Improve "unsaved content" style

Make the message more visible by using the MUI Alert component.

Add chatbot integration

Add setting to show/hide line numbers in review mode

Line numbers are shown when the app is in review mode.
We would like to add a setting (in the general display settings) that toggles the display of the line number on and off.
Currently:

Add code coverage commit check in test workflow

Move to vitejs

Fix settings for code review, add langage select in tab and remove FAB

Filter `live_code` app data so that admins only see their own code when they open in the player

Change language of codemirror text editor to raw text when editing settings

Do not trigger cypress run on changelog modification

Could use a paths-ignore rule on the on key. With CHANGELOG.md as path

Improve documentation

Improve visual representation of the pre-loaded packages

We could use Chips to show the pre-installed packages.

Allow to minimize console or figure panes in code view

Allow saving files in app data

Add bot identities

allow teacher to export app data

As with app actions, a teacher / admin should be able to export all of the apps data as a JSON.

This should be a simple button that can be pressed.

Fix unexpected view switch to default view

The default view when a view setting is not available should not be the code editing. It should ask to reload the app or to configure it.

Update cypress workflow to use cypress auto install step

Cypress action has an auto-install step that can cash the dependencies.

Change app layout to allow specific modes

App should allow to configure in different mode:

Review mode: show a preset code sample to review
IDE mode: allow users to create code samples, and edit them
Execution mode: use the app as a repl and save the code

Add table view for live code in teacher view

Make input prompt a pop up

Add auto-resize

Migrate features from code review app

Feature migration:

Add tooltips to repl buttons

Update ci/cd workflows

Adapt the workflows so they match the most recent updates carried out in the graasp-deploy repository

Improve loading of AppData (seed related)

Remove old resizing mechanism

Improve chatbot prompt preview text

Improve Loading indicator

Use React.useSuspense while waiting for things to load to not render useless things

Default App View can load too much things (pyodide) while it waits for the appMode Setting.

Add app actions

Add analytic to the app by submitting app actions when users perform actions.

Add fullscreen mode

Init project and setup tools

Adapt workflows to refactoring

Update .gitignore

# yarn
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions
yarn-error.log*
yarn-debug.log*

Add diff view in code

Fix PresetView

PresetView shows user comments. It should not.

Allow preloading python packages

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.