Benjamin Bädorf
a9e29279ea
|
2 years ago | |
---|---|---|
.. | ||
README.md | 2 years ago |
README.md
OpenProject development Setup on Mac OS X
To develop OpenProject a setup similar to that for using OpenProject in production is needed.
This guide assumes that you have a Mac OS X installation with administrative rights. OpenProject will be installed with a PostgreSQL database.
Please note: This guide is NOT suitable for a production setup, but only for developing with it!
If you find any bugs or you have any recommendations for improving this tutorial, please, feel free to send a pull request or comment in the OpenProject forums.
Prepare your environment
We'll use homebrew to install most of our requirements. Please install that first using the guide on their homepage.
Install Ruby
Use rbenv and ruby-build to install Ruby. We always require the latest ruby versions, and you can check which version is required by checking the Gemfile for the ruby "~> X.Y"
statement. At the time of writing, this version is "3.1.2"
Install rbenv and ruby-build
rbenv is a ruby version manager that lets you quickly switch between ruby versions. ruby-build is an addon to rbenv that installs ruby versions.
# Install
$ brew install rbenv ruby-build
# Initialize rbenv
$ rbenv init
Installing ruby-3.0
With both installed, we can now install the actual ruby version 3.0. You can check available ruby versions with rbenv install --list
.
At the time of this writing, the latest stable version is 3.1.2
, which we also require.
We suggest you install the version we require in the Gemfile. Search for the ruby '~> X.Y.Z'
line
and install that version.
# Install the required version as read from the Gemfile
rbenv install 3.1.2
This might take a while depending on whether ruby is built from source. After it is complete, you need to tell rbenv to globally activate this version
rbenv global 3.1.2
You also need to install bundler, the ruby gem bundler.
gem install bundler
Setup PostgreSQL database
Next, install a PostgreSQL database. If you wish to use a MySQL database instead and have installed one, skip these steps.
# Install postgres database
$ brew install postgres
# Create the database instance
$ postgres -D /usr/local/var/postgres
Then, create the OpenProject database user and accompanied database.
$ createuser -d -P openproject
You will be prompted for a password, for the remainder of these instructions, we assume its openproject-dev-password
.
Now, create the database openproject_dev
and openproject_test
owned by the previously created user.
$ createdb -O openproject openproject_dev
$ createdb -O openproject openproject_test
Install Node.js
We will install the latest LTS version of Node.js via nodenv. This is basically the same steps as for rbenv:
Install nodenv and node-build
# Install
$ brew install nodenv node-build
# Initialize nodenv
$ nodenv init
Install latest LTS node version
You can find the latest LTS version here: nodejs.org/en/download
At the time of writing this is v16.17.0. Install and activate it with:
nodenv install 16.17.0
nodenv global 16.17.0
Update NPM to the latest version
npm install npm@latest -g
Verify your installation
You should now have an active ruby and node installation. Verify that it works with these commands.
$ ruby --version
ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-linux]
$ bundler --version
Bundler version 2.3.12
node --version
v16.17.0
npm --version
8.12.1
Install OpenProject
# Download the repository
git clone https://github.com/opf/openproject.git
cd openproject
Note that we have checked out the dev
branch of the OpenProject repository. Development in OpenProject happens in the dev
branch (there is no master
branch).
So, if you want to develop a feature, create a feature branch from a current dev
branch.
Configure OpenProject
Create and configure the database configuration file in config/database.yml
(relative to the openproject-directory.
vim config/database.yml
Now edit the config/database.yml
file and insert your database credentials.
It should look like this (just with your database name, username, and password):
default: &default
adapter: postgresql
encoding: unicode
host: localhost
username: openproject
password: openproject-dev-password
development:
<<: *default
database: openproject_dev
test:
<<: *default
database: openproject_test
To configure the environment variables such as the number of web server threads OPENPROJECT_WEB_WORKERS
, copy the .env.example
to .env
and add the environment variables you want to configure. The variables will be automatically loaded to the application's environment.
Finish the Installation of OpenProject
Install code dependencies, link plugin modules and export translation files.
- gem dependencies (If you get errors here, you're likely missing a development dependency for your distribution)
- node_modules
- link plugin frontend modules
- and export frontend localization files
bin/setup_dev
Now, run the following tasks to migrate and seed the dev database, and prepare the test setup for running tests locally.
RAILS_ENV=development bin/rails db:seed
1
Run OpenProject through foreman
You can run all required workers of OpenProject through foreman
, which combines them in a single tab. This is useful for starting out,
however most developers end up running the tasks in separate shells for better understanding of the log output, since foreman will combine all of them.
gem install foreman
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.example
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 and it has known issues with regards to memory (see background worker section below). To disable the worker process:. 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.
You can access the application with the admin-account having the following credentials:
Username: admin
Password: admin
Run OpenProject manually
To run OpenProject manually, you need to run the rails server and the webpack frontend bundler to:
Rails web server
RAILS_ENV=development bin/rails server
This will start the development server on port 3000
by default.
Angular frontend
To run the frontend server, please run
RAILS_ENV=development npm run serve
This will watch for any changes within the frontend/
and compile the application javascript bundle on demand. You will need to watch this tab for the compilation output,
should you be working on the TypeScript / Angular frontend part.
You can then access the application either through localhost:3000
(Rails server) or through the frontend proxied http://localhost:4200
, which will provide hot reloading for changed frontend code.
Delayed Job background worker
RAILS_ENV=development bin/rails jobs:work
This will start a Delayed::Job worker to perform asynchronous jobs like sending emails.
Known issues
Memory management
The delayed_job background worker reloads the application for every job in development mode. This is a know issue and documented here: https://github.com/collectiveidea/delayed_job/issues/823
Spawning a lot of browser tabs
If you haven't run this command for a while, chances are that a lot of background jobs have queued up and might cause a significant amount of open tabs (due to the way we deliver mails with the letter_opener gem). To get rid of the jobs before starting the worker, use the following command. This will remove all currently scheduled jobs, never use this in a production setting.
RAILS_ENV=development bin/rails runner "Delayed::Job.delete_all"
Start Coding
Please have a look at our development guidelines for tips and guides on how to start coding. We have advice on how to get your changes back into the OpenProject core as smooth as possible.
Also, take a look at the doc
directory in our sources, especially the how to run tests documentation (we like to have automated tests for every new developed feature).
Troubleshooting
The OpenProject logfile can be found in log/development.log
.
If an error occurs, it should be logged there (as well as in the output to STDOUT/STDERR of the rails server process).
Questions, Comments, and Feedback
If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community.openproject.org forum. Follow OpenProject on twitter, and follow the news to stay up to date.