Code Monkey home page Code Monkey logo

codesplainui's Introduction

Codesplain UI CircleCI

UI layer for Codesplain, an application to have your code explain itself to you.

Features

Integrated IDE

Codesplain utilizes Codemirror to provide an IDE experience to the user. Paste in a code snippet, or write one right in the browser!

Filtering by Concept

Codesplain analyzes your code and presents you with a list of language concepts present in it. Pick out which concepts are important to you, and they will be highlighted in the IDE.

Annotations in the Margins

Once your code is written, you can add an annotation to a line by clicking its number. Say anything you want about it. Markdown is even supported.

Save and Share

Once you are all done, save your code to a persistant URL, and we'll hold on to it for you or anyone you want to show it to.

Serverless Application

This application is built as a React SPA and uses AJAX for data requests to a REST API. As a result, the application can be deployed serverless. For a better idea of what that looks like, see https://github.com/maryvilledev/codesplain-lambdas.

codesplainui's People

Contributors

dane-johnson avatar solkaz avatar hopding avatar thebho avatar smokingun avatar

Stargazers

Armaan Dhanji avatar  avatar

Watchers

James Cloos avatar Lane Maxwell avatar  avatar Jim McBride avatar  avatar  avatar Ali Zaidi avatar  avatar

codesplainui's Issues

Wireframe User Interface

Left Panel: Array of Token Types with check boxes for adding highlights
Center: Text Form for adding code. Can click on token to highlight
Right: Display token name, Syntax DB description and Code Snippet

Make a Toolbar component for the snippet editor

I propose making a toolbar for the snippet editor to provide a hub for modifying options for the editor, such as

  • Snippet name (Add or change name)
  • Snippet language
  • Lock button
  • Save/Save As
  • Clear
  • Turn On/Off Highlight(maybe)

Add Button to create a new snippet

Creating a new snippet currently involves navigating back to the home screen manually in the browser bar. There should be a button that does this for the user.

Disable inactive parsers

I like that you can see the "Go" language selector, but we should disable that selection until we have that functionality

Add AST Chunker

The code for obtaining an AST of live input now exists. The JSON chunking code from the demo_ui project needs to be ported in order to process those ASTs.

Display an AST in the UI

Recreate Joel's live parsing in the Material UI. No highlighting required. Just parse and create the tree in real time.

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.