Télécharger (5,38 ko)

README.md

Mathias Rouan, 03/11/2015 11:12

 
1
# What is POPS ?
2

    
3
POPS project is a set of additions to Redmine which aims to turn Redmine into a collaborative scientific platform.
4
This include a focus to documents and project pages plus a full design revamp.
5

    
6
The POPS project is composed of several sub-projects :
7

    
8
* [redmine-pops-engine](https://github.com/LETG/redmine-pops-engine) is an engine you can mount in Redmine to change Redmine design.
9
* [redmine-pops](https://github.com/LETG/redmine-pops) is a set of changes brought to Redmine for POPS custom use.
10
* [redmine-invitable](https://github.com/LETG/redmine-invitable) is a plugin allowing you to invite people to join Redmine per project.
11
* [redmine-documents-pops](https://github.com/LETG/redmine-documents-pops) is a plugin changing how documents behave in Redmine.
12

    
13
# Installation guide
14

    
15
### Dependencies
16

    
17
In order for POPS to work properly, you will need the following installed :
18

    
19
* Ruby 2.1.0 and greater
20
* Redmine 2.6.x (< 3.0)
21
* PostgreSQL 9.1 and greater or MySQL
22
* ImageMagick (imagemagick, libmagickwand-dev)
23

    
24
## Method 1: Install from scratch
25

    
26
* Clone this repository and its submodules
27

    
28
```
29
$ git clone --recursive https://github.com/LETG/pops.git
30
```
31

    
32
* Follow the [installation procedure of Redmine](http://www.redmine.org/projects/redmine/wiki/redmineinstall#Installation-procedure)
33

    
34
* Follow the installation procedure of plugins
35

    
36
```
37
$ rake redmine:plugins:migrate
38
```
39

    
40
## Method 2: Install in an existing Redmine instance
41

    
42
By its nature, POPS needs to override some Redmine functionnalities.
43
As such, this will not be a straightforward installation process and knowledge of Rails is highly recommended.
44

    
45
* Download and install all the required plugins
46

    
47
In addition to pops plugins described above, the project also has a couple of additional dependencies.
48
For the full POPS experience, you need to download and install the followings :
49

    
50
* `redmine_ckeditor` - [Docs](https://github.com/a-ono/redmine_ckeditor)
51
:warning: With version 1.0.20, if you choose to clone it do it via `git clone https://github.com/a-ono/redmine_ckeditor.git --single-branch -b 1.0.20 --depth 1`
52
* `redmine_http_auth` - [Docs](https://github.com/kevinfoote/redmine_http_auth)
53

    
54
* Download and install POPS plugins
55

    
56
```bash
57
$ cd plugins
58
$ git clone https://github.com/LETG/redmine-pops.git pops_project --depth 1
59
$ git clone https://github.com/LETG/redmine-invitable.git invitable --depth 1
60
$ git clone https://github.com/LETG/redmine-documents-pops.git documents_pops --depth 1
61
```
62

    
63
Then in Redmine root folder, execute the followings
64

    
65
```bash
66
$ bundle install
67
$ rake redmine:plugins:migrate
68
$ rake redmine:pops_project_create_roles
69
```
70

    
71
Your redmine instance should still be working at this point!
72

    
73
* Install the POPS engine and mount it
74

    
75
```bash
76
$ mkdir engines && cd engines
77
$ git clone https://github.com/LETG/redmine-pops-engine.git --depth 1
78
```
79

    
80
In redmine root directory, create a file called Gemfile.local and add :
81
```ruby
82
gem 'pops_redmine_engine', path: 'engines/redmine-pops-engine'
83
```
84

    
85
In the redmine config/additional_environment.rb, add the following :
86

    
87
```ruby
88
config.paths['app/views'].unshift(PopsRedmineEngine::Engine.root.join('app', 'views'))
89
config.paths['app/helpers'].unshift(PopsRedmineEngine::Engine.root.join('app', 'helpers').to_s)
90
config.paths['lib'].unshift(PopsRedmineEngine::Engine.root.join('lib'))
91
```
92

    
93
* Install the Foundation Theme engine and mount it
94

    
95
```bash
96
$ mkdir engines && cd engines
97
$ git clone https://github.com/dotgee/redmine-foundation-theme.git --depth 1
98
```
99

    
100
Edit Gemfile.local and add :
101

    
102
```ruby
103
gem 'foundation_theme', path: 'engines/redmine-foundation-theme'
104
```
105

    
106
In config/additional_environment.rb, add :
107

    
108
```
109
config.paths['app/views'].unshift(FoundationTheme::Engine.root.join('app', 'views'))
110
config.paths['app/helpers'].unshift(FoundationTheme::Engine.root.join('app', 'helpers').to_s)
111
config.paths['lib'].unshift(FoundationTheme::Engine.root.join('lib'))
112

    
113
config.assets.enabled = true
114

    
115
config.assets.paths << "#{Rails.root}/public/stylesheets/"
116
config.assets.paths << "#{Rails.root}/public/javascripts/"
117
config.assets.paths << "#{Rails.root}/public/images/"
118
```
119

    
120

    
121
### Troubleshooting
122

    
123
* Column doesn't exist / Migrations were not run
124

    
125
Plugins folders need to have a specific name for their migrations to be ran. Please make sure they have the name specified in above steps.
126

    
127
### Authors
128

    
129
* [@almerino](https://github.com/almerino)
130
* [@jchapron](https://github.com/jchapron)
131
* [@dotgee](https://github.com/dotgee)
132

    
133
### Contributing
134

    
135
POPS is an open source project and we encourage contributions.
136

    
137
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
138

    
139
Here are some ways **you** can contribute:
140

    
141
* by reporting [bugs](https://github.com/LETG/redmine-pops/issues/new)
142
* by writing or editing documentation
143
* by writing [specs](https://github.com/LETG/redmine-pops/labels/specs)
144
* by writing [needed code](https://github.com/LETG/redmine-pops/labels/code) or [finishing code](https://github.com/LETG/redmine-pops/labels/stalled)
145
* by [refactoring code](https://github.com/LETG/redmine-pops/labels/performance)
146
* by resolving [issues](https://github.com/LETG/redmine-pops/issues)
147
* by reviewing [pull requests](https://github.com/LETG/redmine-pops/pulls)
148

    
149
### Licence
150

    
151
POPS is released under the [GNU GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/gpl-3.0.html).  See the [`LICENSE.md`](https://github.com/LETG/redmine-pops/blob/master/LICENSE.md) file.