deblan/gist
2
2
Fork 3
Code Issues Pull requests Releases 3 Wiki Activity
GIST is an open-source application to share code. https://gist.deblan.org
62 commits 2 branches 32 tags 464 KiB
PHP 44.2%
HTML 24.3%
Twig 24.3%
CSS 4.4%
JavaScript 2.3%
Other 0.5%
Go to file
Simon Vieille 109b43cc77 README
2015-07-19 18:42:22 +02:00
app API base_uri 2015-07-19 18:24:43 +02:00
src/Gist README 2015-07-19 18:39:46 +02:00
web css 2015-06-27 15:47:04 +02:00
.bowerrc First template 2015-05-04 22:12:26 +02:00
.gitignore readme, gitignore 2015-05-06 23:05:51 +02:00
bower.json Encrypted code embeding, pages titles 2015-05-11 21:06:41 +02:00
composer.json API client 2015-07-19 18:19:43 +02:00
LICENSE Init commit 2015-05-04 20:52:00 +02:00
Makefile Makefile and README 2015-05-10 02:32:24 +02:00
propel-dist.yaml rsync 2015-05-06 22:51:51 +02:00
README.md README 2015-07-19 18:42:22 +02:00

README.md

GIST

GIST is an open-source application to share code. https://www.deblan.io/post/517/gist-est-dans-la-place

Gist

Requirements

  • PHP >= 5.4
  • GIT
  • MySQL, PostgreSQL or SQLite
  • Composer (php)
  • Bower (node)

Installation

$ git clone https://gitlab.deblan.org/deblan/gist
$ cd gist
$ make
$ mv propel-dist.yaml propel.yaml
$ # EDIT propel.yaml (dsn)
$ make propel

Screencast: https://asciinema.org/a/19814

Git

Git can maybe be downloaded from your system's repositories.

$ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"

Composer

Composer can maybe be downloaded from your system's repositories. Else, follow the next instructions:

Download

# With cURL
curl -sS https://getcomposer.org/installer | php

# With Wget
wget -O - -q https://getcomposer.org/installer | php

You can now use it with php composer.phar [arguments].

Executable

mv composer.phar composer
chmod +x composer

Use it with ./composer [arguments].

Install

Assuming ~/bin exists ans is in $PATH.

mv composer ~/bin

Dependencies Installation (from composer.lock)

composer install

Dependencies Update (will change composer.lock)

composer update

Bower

Install

npm install -g bower

Dependencies Installation (from bower.json)

bower install

Dependencies Update

bower install

Makefile

A Makefile is provided to automate some tasks.

  • make will install application's dependencies via Composer and Bower,
  • make optimize will run Composer's autoloader dump script with classmap
  • make update will update the application
  • make propel will generate propel's files

API

Create a new gist

POST /{locale}/api/create Params:

  • form[title]: String (required, can be empty)
  • form[type]: String (required) Values: html, css, javascript, php, sql, xml, yaml, perl, c, asp, python, bash, actionscript3, text
  • form[content]: String (required)

Responses:

  • Code 200: A json which contains gist's information Example:

{ "url":"f4afbf7296", "gist": { "Id":66, "Title": "test prod", "Cipher": false, "Type": "javascript", "File": "55abcfa7771e0", "CreatedAt": "2015-07-19T16:26:15Z", "UpdatedAt": "2015-07-19T16:26:15Z" } }

* Code ```405```: Method Not Allowed
* Code ```400```: Bad Request