Quick Start for Developers

Detailed installation instructions for different platforms are located on the OpenProject website.

You can find information on configuring OpenProject in config/CONFIGURATION.md.

Fast install

These are generic (and condensed) installation instructions for the current dev branch without plugins, and optimised for a development environment. Refer to the OpenProject website for instructions for the stable branch, OpenProject configurations with plugins, as well as platform-specific guides.

Prerequisites

Git
Database (MySQL 5.x/PostgreSQL 8.x)
Ruby 2.1.x
Node.js (version v0.10.x)
Bundler (version 1.5.1 or higher required)

Install Dependencies

Install Ruby dependencies with Bundler:
```
 bundle install
```
Install JavaScript dependencies with npm:
```
 npm install
```
Install foreman gem:
```
 [sudo] gem install foreman
```

Configure Rails

Copy config/database.yml.example to config/database.yml:
```
 cd config
 cp database.yml.example database.yml
```
Edit database.yml according to your preferred database's settings.
Copy config/configuration.yml.example to config/configuration.yml:
```
 cp configuration.yml.example configuration.yml
 cd ..
```
Edit configuration.yml according to your preferred settings for email, etc. (see config/CONFIGURATION.md for a full list of configuration options).

Create databases, schemas and populate with seed data:

 # bundle exec rake db:create:all
 # bundle exec rake db:migrate
 # bundle exec rake db:seed

Generate a secret token for the session store:
```
 bundle exec rake generate_secret_token
```

Run!

Start OpenProject in development mode:
```
 foreman start -f Procfile.dev
```
The application will be available at http://127.0.0.1:5000. To customize bind address and port copy the .env.sample provided in the root of this project as .env and configure values as required.

By default a worker process will also be started. In development asynchronous execution of long-running background tasks (sending emails, copying projects, etc.) may be of limited use. To disable the worker process:
```
 echo "concurrency: web=1,assets=1,worker=0" >> .foreman
```
For more information refer to Foreman documentation section on default options.

3.8 KiB Raw Blame History Unescape Escape