Skip to content

jpscharf/Dash-Annotations

 
 

Repository files navigation

Dash Annotations Server

Follow these instructions if you want to set up your own annotation server.

Installation

  • Install Lumen
  • Add a MySQL database called "annotations"
  • Clone this repo over your Lumen install
  • Rename the .env.example file to .env and edit it
  • Run composer install
  • Install Python and Pygments (used for syntax highlighting)
    • Make sure /bin/pygmentize exists. If it doesn't, add a link between /bin/pygmentize to wherever you installed Pygments
  • Run php artisan migrate and type Y to confirm you want to do it in production
  • Open http://{your_server}/users/logout in your browser and check if you get a JSON response that says you're not logged in
  • Let Dash know about your server by running this command in Terminal:
# Repeat on every Mac that will connect to your server:
defaults write com.kapeli.dashdoc AnnotationsCustomServer "http(s)://{your_server}"

About

The source code for the Dash annotations server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 99.6%
  • ApacheConf 0.4%