Git Product home page Git Product logo

aicodes--dashboard's Introduction

AI.codes dashboard

AI.codes dashboard is an Electron app. It provides insightful information as developers code.

Quick start

The only development dependency of this project is Node.js. So just make sure you have it installed. Then type few commands known to every Node developer...

git clone https://github.com/aicodes/dashboard
cd dashboard
npm install
npm start

... and boom! You have running desktop application on your screen.

Core Pieces

  • The app will start a local HTTP/WebSocket server, listening to localhost:26337 in the main thread.
  • For good user experience, most of HTTP requests from editor return immediately. If no answers can be found by checking local cache, the request is forwarded to https://api.ai.codes.
  • The WebSocket endpoint receives stream of events from editors to help AI make decisions, but none of your code will be uploaded to server.

Technical notes

  • You can and should use ES6 (latest Javascript standard) code style. The app is configured to understand ES6 under src. The lint tool helps preventing a lot of bugs. To run lint, use eslint --fix src.
  • To run the dashboard, use npm run start. The app listens on localhost:26337.
  • The local server is implemented using express.js framework. Most of the code is in editor_api.js. The part that interacts with server is in local_server.js.

Editor APIs

Will have better documentation soon, but for now.

aicodes--dashboard's People

Contributors

antoinepairet avatar black-snow avatar bradvogel avatar brandonhamilton avatar carlosperate avatar coskuntekin avatar crucialfelix avatar denysvitali avatar eisenkolb avatar high5 avatar huyhong avatar idleberg avatar ingro avatar jonatasfreitasv avatar jpedius avatar jsumners avatar lazamar avatar marcelocg avatar markmont avatar pcewing avatar plrthink avatar rodrigok avatar romannekhor avatar szwacz avatar thom-x avatar tkdave avatar turadg avatar tyv avatar xuy avatar zeke avatar

Watchers

 avatar  avatar

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.