gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1193 from kormoc/contributing_updates

Browse source 
Minor Contributing documentation updates.
This commit is contained in:
Christian Bruckmayer 2017-03-02 14:07:19 +01:00 • committed by GitHub
commit 7844554817
4 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -1,5 +1,5 @@
# Request for contributions
We are always looking for contributions to OSEM. Read this guide on how to do that.
We are always looking for contributions to OSEM. Read this guide on how to do that.
In particular, this community seeks the following types of contributions:
@ -10,7 +10,7 @@ In particular, this community seeks the following types of contributions:
### Runing OSEM for development
We are using [Vagrant](https://www.vagrantup.com/) to create our development environments.
1. Install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads). Both tools support Linux, MacOS and Windows.
1. Install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox 5.0.10](https://www.virtualbox.org/wiki/Download_Old_Builds_5_0). Both tools support Linux, MacOS and Windows.
2. Install [vagrant-exec](https://github.com/p0deje/vagrant-exec):
@ -33,7 +33,7 @@ We are using [Vagrant](https://www.vagrantup.com/) to create our development env
5. Start your OSEM rails app:
```
vagrant exec rails server -b 0.0.0.0
vagrant exec /vagrant/bin/rails server -b 0.0.0.0
```
6. Check out your OSEM rails app:

11
Vagrantfile vendored
View file

@ -39,6 +39,17 @@ Vagrant.configure(2) do |config|
# argument is a set of non-required options.
# config.vm.synced_folder "../data", "/vagrant_data"
# When using the default settings, we will attempt to mount this share
# as the vagrant user and the vagrant group. Alas, box opensuse/openSUSE-42.1-x86_64
# does not have the vagrant group created, so this share fails and
# requires manual mounting for the vagrant setup to continue. Setting
# to the hardcoded numbers will allow the mount to successfully
# mount without working about the group mismatch
VAGRANT_UID = 1000 # User vagrant
VAGRANT_GID = 100 # Group users
config.vm.synced_folder ".", "/vagrant",
owner: VAGRANT_UID, group: VAGRANT_GID
# Provider-specific configuration so you can fine-tune various
# backing providers for Vagrant. These expose provider-specific options.
# Example for VirtualBox:

8
bootstrap.sh
View file

@ -24,11 +24,11 @@ if [ ! -f /vagrant/config/database.yml ] && [ -f /vagrant/config/database.yml.ex
else
echo -e "\n\nWARNING: You have already have a development/test database."
echo -e "WARNING: Please make sure this database works in this vagrant box!\n\n"
fi
fi
else
echo -e "\nnWARNING: You have already configured your database in config/database.yml."
echo -e "WARNING: Please make sure this configuration works in this vagrant box!\n\n"
echo -e "\nnWARNING: You have already configured your database in config/database.yml."
echo -e "WARNING: Please make sure this configuration works in this vagrant box!\n\n"
fi
echo -e "\nProvisioning of your OSEM rails app done!"
echo -e "To start your development OSEM run: vagrant exec rails server -b 0.0.0.0\n"
echo -e "To start your development OSEM run: vagrant exec /vagrant/bin/rails server -b 0.0.0.0\n"

3
config/environments/development.rb
View file

@ -1,6 +1,9 @@
Osem::Application.configure do
# Settings specified here will take precedence over those in config/application.rb
# Allow the web console from the vagrant host ip
config.web_console.whitelisted_ips = '10.0.2.2'
# Use letter_opener_web for Vagrant (launchy won't work)
config.action_mailer.delivery_method = ENV['USER'] == 'vagrant' ? :letter_opener_web : :letter_opener