Blame README.rst

Pierre-Yves Chibon fe5017
Pagure
Pierre-Yves Chibon 2088eb
======
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
:Author:  Pierre-Yves Chibon <pingou@pingoured.fr></pingou@pingoured.fr>
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
Pagure is a git-centered forge, python based using pygit2.
Pierre-Yves Chibon 78e123
Pierre-Yves Chibon 306158
With pagure you can host your project with its documentation, let your users
Pierre-Yves Chibon 306158
report issues or request enhancements using the ticketing system and build your
Pierre-Yves Chibon 306158
community of contributors by allowing them to fork your projects and contribute
Pierre-Yves Chibon 306158
to it via the now-popular pull-request mechanism.
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 2088eb
Rahul Bajaj 29b73b
Homepage: https://pagure.io/pagure
Stanislav Ochotnicky 6739d2
Pierre-Yves Chibon 4951c5
See it at work: https://pagure.io
Pierre-Yves Chibon 4951c5
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 4951c5
Playground version: https://stg.pagure.io
Pierre-Yves Chibon 4951c5
Pierre-Yves Chibon 22c46f
Pierre-Yves Chibon bfbc7c
Pierre-Yves Chibon 2088eb
Get it running
Pierre-Yves Chibon 2088eb
==============
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 5dc04a
* Install the needed system libraries::
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 306158
    sudo dnf install git python-virtualenv libgit2-devel \
Pierre-Yves Chibon 306158
                     libjpeg-devel gcc libffi-devel redhat-rpm-config
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 306158
  .. note:: Do note the version of libgit2 that you install, for example in
Pierre-Yves Chibon 306158
    ``libgit2-0.23.4-1`` you need to keep in mind the ``0.23``
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 2088eb
* Retrieve the sources::
Pierre-Yves Chibon 2088eb
Rahul Bajaj 29b73b
    git clone https://pagure.io/pagure.git
Daniel Mach d27126
    cd pagure
Daniel Mach d27126
Daniel Mach d27126
* Install dependencies
Daniel Mach d27126
Pierre-Yves Chibon 306158
  * create the virtualenv::
Daniel Mach d27126
Pierre-Yves Chibon 306158
      virtualenv pagure_env
Pierre-Yves Chibon 306158
      source ./pagure_env/bin/activate
Daniel Mach d27126
Pierre-Yves Chibon 306158
  * Install the correct version of pygit2::
Daniel Mach d27126
Pierre-Yves Chibon 306158
      pip install pygit2==<version found="" libgit2="" of="">.*</version>
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
    So in our example::
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
      pip install pygit2==0.23.*
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
  * Install the rest of the dependencies::
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 306158
      pip install -r requirements.txt
Pierre-Yves Chibon 2088eb
Sayan Chowdhury 367479
Pierre-Yves Chibon 306158
* Create the folder that will receive the projects, forks, docs, requests and
Pierre-Yves Chibon 306158
  tickets' git repo::
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 306158
    mkdir {repos,docs,forks,tickets,requests}
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 306158
Pierre-Yves Chibon 306158
* Create the inital database scheme::
Daniel Mach d27126
Sayan Chowdhury 367479
    python createdb.py
Sayan Chowdhury 367479
Sayan Chowdhury 367479
Pierre-Yves Chibon 2088eb
* Run it::
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 40cf0a
    ./runserver.py
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon 2088eb
Pierre-Yves Chibon b42030
* To get some profiling information you can also run it as::
Pierre-Yves Chibon b42030
Daniel Mach d27126
    ./runserver.py --profile
Pierre-Yves Chibon b42030
Pierre-Yves Chibon b42030
Pierre-Yves Chibon d0bf8c
This will launch the application at http://127.0.0.1:5000