Skip to content

Pfuster12/code-link

Repository files navigation

Welcome to code-link

Commitizen friendly

A react x electron code editor.

Latest Changelog

code-link is still in alpha.

Get started

code-link is an electron app. Visit the electron docs to get started in your machine. Written in Typescript, because it's so much better.

Simple steps to boot it up:

  • Download current Node.js
  • Clone this project into a directory
  • Install dependencies with npm install
  • Create a .env file in the root dir. See dotenv package
  • (Optional) Install React Developer Tools in Chrome and populate the .env file local path name.
  • Run npm start

Project Structure

- public
  - themes // Public code editor themes packaged into project
- src
  - io // File and Network IO
  - lexer // Language Lexer and Plugins
  - rebderer // Render thread components
    - assets 
    - components // Reusable components
    - utils
  - main // main thread

Project Development

Follow loosely the development of the project in the dev blog

Documentation

Check the wiki for documented electron issues affecting the app and workarounds if necessary.

Version Control

This repo uses Commitizen for AngularJS format commit messages. Run git cz to start a commit.