README.hu.md

PéK-Next

A Schönherz Kollégium és a SVIE nyilvántartó rendszere

Rendszerkövetelmények

• Ruby 2.5.7
• Postgresql 9.6
• Node (asset fordítás)
• Redis (választható)

vagy

• Docker

Függőségek telepítése

Debian alapú rendszerekhez

Csomagok

# A Redis választható
sudo apt install postgresql-9.6 libpq-dev nodejs redis-server

Ruby 2.5.7

Asdf használata ajánlott ruby pluginnel vagy rbenv önmagában. Telepítsd a Ruby 2.5.7-et, majd állítsd be a futtatni kívánt verziót. Az éppen aktív verziót a ruby -v paranccsal tudod lekérdezni.

MacOS

Brew

A legegyszerűbb, ha telepítjük a brew csomagkezelőt, majd ezzel a további függőségeket.

# A Redis választható
brew install asdf [email protected] redis
brew services start [email protected]
brew services start redis

Ruby 2.5.7 és Node

Add hozzá a ruby és node bővítményeket az asdfhez. Telepítsd a Ruby 2.5.7-et, majd állítsd be a futtatni kívánt verziót. Az éppen aktív verziót a ruby -v paranccsal tudod ellenőrizni.

Beállítás

Forráskód és függőségek

git clone https://github.com/kir-dev/pek-next.git
cd pek-next
gem install bundler
bundle install

Környezeti változók

A használni kívánt értékekkel töltsd fel a .env fájlt a .env.example alapján.

Adatbázis

sudo su postgres
psql -c 'create user "pek-next" with superuser password '\''pek-next'\'';'

Adatbázis inicializálása

Saját felhasználóként

rake db:setup

Futtatás

Szerver

rails s

Worker (választható, redis-t követel)

bundle exec sidekiq

Tesztek futtatása

rake test

Telepítés

A legegyszerűbb mód a docker-compose használata.

A használni kívánt értékekkel töltsd fel a .env fájlt a .env.example alapján. Az APP_ID és APP_SECRET változót az auth.sch-ról kapott értékekkel töltsd ki. A SECRET_KEY_BASE-t a bundle exec rake secret parancs segítségével tudod legenerálni.

Futtasd a következő prancsokat:

# Nem szükséges ezeket a köteteket név szerint felvenni, így viszont könnyebb lehet hivatkozni rájuk később.
docker volume create pek_public
docker volume create pek_database
docker-compose up --build

Miután létrejöttek és futnak a szükséges háttérszolgáltatások / konténerek, add ki az alábbi parancsokat:

# Ez csak akkor szükséges, ha először telepíted a PéK-et
docker-compose run web bash -c "bundle exec rake db:setup"

# Csak akkor szükséges ha van olyan migráció, ami még nem futott le
docker-compose run web bash -c "bundle exec rake db:migrate"

# Ez csak új telepítésnél és asset váltáskor szükséges
docker-compose run web bash -c "bundle exec rake assets:precompile"

Ismert nehézségek és megoldások

A Ruby nem tud natív kiegészítőket telepíteni

sudo apt install ruby-dev

Rbenv telepítés csak ruby-build használati utasításokat ad

rbenv install -v 2.5.7

Az Rbenv nem befolyásolja a Ruby verziót

echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc

A telepítés ellenére nem találja a shell a rails parancsot

Indítsd újra a terminálod

Készítette: Kir-Dev Team

Külön köszönet