gist/README.md

89 lines
1.5 KiB
Markdown
Raw Normal View History

2015-05-06 10:58:55 +02:00
GIST
====
GIST is an open-source application to share code.
Requirements
------------
* PHP >= 5.4
* GIT
2015-05-06 11:04:38 +02:00
* Composer (php)
* Bower (node)
2015-05-06 10:58:55 +02:00
Installation
------------
2015-05-06 11:10:26 +02:00
$ git clone https://gitlab.deblan.org/deblan/gist
$ cd gist
2015-05-06 10:58:55 +02:00
$ make
2015-05-06 23:05:51 +02:00
Git
---
$ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"
2015-05-06 10:58:55 +02:00
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 (will change `bower.json`)
bower update
Makefile
--------
A Makefile is provided to automate some tasks.
* `make` will install application's dependencies via Composer,
* `make prod` will install dependencies without developmenent requirements
and run `make optimize`,
* `make optimize` will run Composer's autoloader dump script with classmap
only, without dynamic autoload rules,