Blue Pencil allows you to collaboratively manage data that's stored on Github through a simple form. These forms are public and editing suggestions can be made anonymously. The approval process is fully handled through Pull Requests and is restricted to those with write access to the project.
To set this up, you need to run three projects:
- This repo contains the client side app that serves the form
- Blue Pencil server creates the Pull Requests and handles authentication with Github
- Blue Pencil data is the repo where example data and form configuration is stored.
This project is under active development. To get a sense of the roadmap or contribute, please use the issue queue.
To set up the development environment for this website, you'll need to install the following on your system:
- Node (v4.2.x) & Npm (nvm usage is advised)
The versions mentioned are the ones used during development. It could work with newer ones. Run
nvm useto activate the correct version.
After these basic requirements are met, run the following commands in the website's folder:
$ npm install
This app requires communication with a server which can be found in the blue-pencil-server repo.
After running a local copy add the address to config/production.js:
api: 'http://localhost:[port]'
$ npm run serve
or
$ gulp serve
Compiles the sass files, javascript, and launches the server making the site available at http://localhost:3000/
The system will watch files and execute tasks whenever one of them changes.
The site will automatically refresh since it is bundled with livereload.
Compile the sass files, javascript... Use this instead of gulp serve if you don't want to watch.
$ npm run build
or
$ gulp