spiffcode / ghedit

A fast, powerful web-based code editor for GitHub repositories
https://spiffcode.github.io/ghedit/
MIT License
341 stars 49 forks source link

GHEdit

GHEdit is a fast, rich, open source code editor that runs great in web browsers. It's directly integrated with GitHub so you can work on your projects without installing anything.

Try it!

GHEdit in action

GHEdit is derived from Microsoft's Visual Studio Code. We developed it to learn about web-based development environments and think it is useful enough to share.

Features

Documentation

Read the documentation and FAQ.

Developing

INSTALLING SOURCE

# Clone this repository.
git clone https://github.com/spiffcode/ghedit.git

# Install npm packages
cd <project_root>
./scripts/npm.sh install
cd <project_root>/ghedit
npm install

# Build
cd <project_root>/ghedit
npm run build

# Build targets:
# build - loose js files
# build-opt - packed not minimized. Requires ?b=opt when on localhost.
# build-min - packed and minimized. Requires ?b=min when on localhost.

RUNNING LOCALLY

npm run http-server

Now browse to http://localhost:8000

PUSHING TO GITHUB.IO

# Push the build-min version to github.io
npm run push