https://github.com/pfuster12/code-link

React x Electron Code Editor
https://github.com/pfuster12/code-link

code-editor commitizen electron nodejs open-source react typescript webpack

Last synced: 8 months ago
JSON representation

React x Electron Code Editor

• Host: GitHub
• URL: https://github.com/pfuster12/code-link
• Owner: Pfuster12
• License: mit
• Created: 2019-04-05T08:57:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:46:58.000Z (almost 3 years ago)
• Last Synced: 2025-03-30T16:11:39.495Z (9 months ago)
• Topics: code-editor, commitizen, electron, nodejs, open-source, react, typescript, webpack
• Language: TypeScript
• Homepage:
• Size: 1.31 MB
• Stars: 3
• Watchers: 0
• Forks: 2
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Welcome to code-link

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

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](https://electronjs.org/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](https://nodejs.org/en/)

- Clone this project into a directory

- Install dependencies with `npm install`

- Create a `.env` file in the root dir. See [dotenv package](https://www.npmjs.com/package/dotenv)

- (Optional) Install React Developer Tools in Chrome and populate the `.env` file local path name.

- Run `npm start`

## Project Structure

```js

- 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](https://io-pabs.hashnode.dev/)

## Documentation

Check the [wiki](https://github.com/Pfuster12/code-link/wiki) for documented electron issues affecting the app and workarounds if necessary.

## Version Control

This repo uses [Commitizen](https://github.com/commitizen/cz-cli) for AngularJS format commit messages. Run `git cz` to start a commit.