Skip to content

Jpe230/JPEditor

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

Jpeditor

Code editor inspired in VSCode, powered by React, Monaco and Electron
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

ss2

This project serves as a foundation of a simple code editor, it is powered by Electron and Monaco, making it as powerful as VSCode can be, this is my first time experimenting with those libraries so expect tons of bugs, I don't plan in updating this repo so feel free to adopt this project if you want.

I only really wanted to test, how difficult it could be to integrate Monaco.

(back to top)

Built With

(back to top)

Getting Started

You will need to use yarn for this project, so install it and pray it compiles, I didnot make so much hackery to get it to work but YMMV

Prerequisites

Install modules using yarn:

  • yarn
    yarn install

Executing

  1. Clone the repo
    git clone https://github.com/jpe230/jpeditor.git
  2. Install yarn packages
    yarn install
  3. Run dev env.
     yarn dev

(back to top)

Usage

ss2 s1 ss3

(back to top)

Roadmap

  • Add more languages
  • Remove hardcoded values
  • Enable more themes
    • Import themes for vscode

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jose Pablo Ramirez - @@angulobtuso - [email protected]

Project Link: https://github.com/jpe230/jpeditor

(back to top)

About

Simple Code Editor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published