https://github.com/khellang/codeinthedark-editor
https://github.com/khellang/codeinthedark-editor
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/khellang/codeinthedark-editor
- Owner: khellang
- License: other
- Created: 2017-10-18T18:49:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-25T19:39:41.000Z (over 7 years ago)
- Last Synced: 2025-03-10T14:51:48.980Z (about 1 year ago)
- Language: CoffeeScript
- Size: 3.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# The official editor for [Code in the Dark](https://github.com/codeinthedark/codeinthedark.github.io)
*Read more about the Code in the Dark competition [here](https://github.com/codeinthedark/codeinthedark.github.io)*
**Try the editor online: http://codeinthedark.com/editor/**
## How to Use
* Grab the contents of the [`dist/`](https://github.com/codeinthedark/editor/tree/master/dist) folder, or download [this zip](https://github.com/codeinthedark/editor/releases/download/v0.1.0/editor.zip). All contestants should be given a copy of the editor.
* Replace `assets/page.png` in the editor files with a screenshot of the page that is to be built in the competition.
* Add any extra assets (e.g. images) that are required to build the page in the `assets/` folder.
* Edit the `assets/instructions.html` file with information about the extra assets and their dimensions.
## Developing
Here's how to install the dependencies and run the editor locally:
```bash
$ npm install
$ ./node_modules/.bin/gulp serve
```
To build the editor, run:
```bash
$ gulp dist
```
This will compile all scripts and styles and inline them into a single html file in the `dist/` folder. It will also create a `dist/assets/` folder, which separately contains the instructions and page screenshot so that they can easily be changed between different rounds of the competition.
## Contributing
Contributions to the editor welcome. If you've fixed a bug or implemented a cool new feature that you would like to share, please feel free to open a pull request here.
## Sponsors
[Entity Framework Extensions](https://entityframework-extensions.net/?utm_source=khellang&utm_medium=codeinthedark-editor) and [Dapper Plus](https://dapper-plus.net/?utm_source=khellang&utm_medium=codeinthedark-editor) are major sponsors and proud to contribute to the development of codeinthedark-editor.
[](https://entityframework-extensions.net/bulk-insert?utm_source=khellang&utm_medium=codeinthedark-editor)
[](https://dapper-plus.net/bulk-insert?utm_source=khellang&utm_medium=codeinthedark-editor)