MetaCell / MetaCell/geppetto-meta

Create example application with backend

Open
#190 1 comment 2 reactions 0 assignees View on GitHub
geppetto.js
Dominant language
JavaScript
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Edit from @afonsobspinto:

We want this application to work as somewhat real documentation / define best practices to develop new applications that want to use geppetto backend.
It should be maintained with the latest.
It should cover parts of geppetto that are not covered by the showcase nor the redux example application
It should be able to be used to automatically test if a change to the geppetto codebase (new feature / refactor, f.e) is a breaking change. This testing shouldn't be very detailed but rather focused on basic features (smoke test)

Where does this new application map with the other applications examples:

| Application | Meant to |
| ------------- | ------------- |
| Geppetto Showcase | Showcase geppetto UI features to the clients |
| React-Redux Example | Showcase how to use flex-layout and widgets to developers |
| Backend Example | Showcase how to use geppetto backend to developers |

How do we add this?
- List backend features to maintain and showcase
- Remove no longer maintained features of pygeppetto (like experiments, etc..)
- Add tornado + flask integration (done on mgv) to pygeppetto
- Document how to use maintained backend features
- Create simple frontend application (basic flex-layout; websocket api (load_project_by_url) + rest openapi)
- Add backend application to handle frontend requests (websocket + rest openapi)
- Create smoke tests for backend application

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the maintained pygeppetto backend features and comparing the existing Geppetto Showcase and React-Redux Example applications. The issue lists the intended frontend, websocket and REST OpenAPI integration, Flask/Tornado support, documentation, and smoke tests; done requires a maintained backend example covering these basic flows.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, javascript, openapi, python
Domain
api, backend, documentation, frontend, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.