Projektin aloitus - Dude Handbook

Dude-ympäristön pystytysohjeet uudelle tietokoneelle löytyy GitHubista, dudestack/instructions.

Vaikka projektin aloitustoimenpiteemme ovatkin enimmäkseen automatisoituja (yksi aloituskomento säästää 10 tuntia aikaa työstä joka normaalisti pitäisi tehdä käsipelillä), on jonkin verran manuaalista työtä, sillä kaikkea ei voi eikä kannata automatisoida huolellisuuden kustannuksella. Lisäksi projektin jatkaja hyppää projektiin mukaan myöhemmin, eikä voi käyttää aloituskomentoja ja näin ollen asioita on tehtävä käsin.

Ensimmäisen aloittajan tehtävät

Vaiheet:

1. Ensimmäinen projektin parissa aloittava dude aloittaa projektin ajamalla aloituskomennon:

createproject

Scripti kysyy oleelliset tiedot projektista, kuten projektin nimen. Sen jälkeen automaatio luo projektin raamit (digitoimistodude/dudestack), luo paikalliselle kehityskonelle (digitoimistodude/marlin-vagrant) virtualhostin sekä WordPress-stackin asiakkaan projektia varten.

2. Seuraavaksi ajetaan newtheme.sh (digitoimistodude/air), joka tarpeelliset tiedot kysyttyään luo projektiin aloitusteeman.

3. Ensimmäinen aloittaja luo seuraavaksi tietokannan kehityspalvelimelle (gunship)

4. Tämän jälkeen projektin aloittaja jakaa .env- määritykset sekä Resilio Sync -linkin mediatiedostoihin Trellon tai Slackin kautta muille projektissa mukana oleville devaajille.

5. Avaa projekti Sublime Textiin komennolla subl ~/Projects/projektinnimitähän tai Sublime Textin valikosta Open Folder. Tämän jälkeen tallenna projekti nimellä painamalla CMD + Shift + P ja kirjoittamalla Add New Project ja enter. Nimeä projekti samalla nimellä kuin kansio, eli uudelleen enter. Tämän jälkeen löydät projektisi jatkossa kun painat Cmd + Shift + O.

Myöhemmin projektiin mukana tulevan devaajan tehtävät

Vaiheet:

1. Muut mukaan tulevat devaajat menevät Duden Bitbucketiin, josta valitsevat aloitetun projektin kloonaavat projektin Clone-nappulan avulla ~/Projects -hakemistoon (Terminalissa: cd ~/Projects ja sen jälkeen git clone url).

2. Luo uusi tiedosto projektikansion alle nimeltä .env (esim. subl ~/Projects/.env tai nano ~/Projects/.env) ja lisää sinne saamasi tiedot. Tyypillinen .env-tiedosto näyttää tältä:

DB_NAME=tässä_on_oikea_tietokannan_nimi
DB_USER=tässä_on_oikea_käyttäjätunnus
DB_PASSWORD=tässä_on_oikea_salasana
DB_HOST=tässä_on_oikea_ip

WP_ENV=development
WP_HOME=http://projektinnimi.test
WP_SITEURL=http://projektinnimi.test/wp
AUTH_KEY='ts[h@+i#]w`Zj%$!*+N:b*K$re9;w*mQ:;Y76G@~wx?::9%j@~}i3dmz|Jcl{|'
SECURE_AUTH_KEY='gJ6.c|6+v~`s}0,^945V#uY]TXuW9gV&Po!SnCKJsB2fV-WlLd]629mm~8_;qXL'
LOGGED_IN_KEY='Eu`SWA<^2P_P:1?i|c=541(&QMYM3h[,B$L]az02%He@;c).e#08zEL&*;oGd/AF'
NONCE_KEY='@#p@/&A@jEJeGo|K}0fm`R8NcaQaA @??J:%97[|c>Gr>*eO[qFAe|$h|qhA?)z'
AUTH_SALT=':ov!]~U]=Jqjy.o#*EddJd*Qd,YD=D3~S{ZC%gn7QD*%y+MbwQf5U iX&69:QYP'
SECURE_AUTH_SALT='Ck(dq+!6vNHTF-U1xZt*IBAk.n)+4DH=Nl;4d5xyf4*LLy?8]sLsT@DO]iGOM$H}'
LOGGED_IN_SALT=']CR.^maG`L*oKL?3 qiTTXE2~)b2m>NPFBKhOKNE qSt1R K8+`nOu&Ea*,n6G2'
NONCE_SALT='?8|fjJSNs8=LwJt6dkWrY*.~(# +EpUC]TI,~}HhVzS*9@K$ =+H!{wOYeG>t}rd'

ACF_PRO_KEY=tässä_on_oikea_API_key
SENDGRID_API_KEY=tässä_on_oikea_API_key
IMAGIFY_API_KEY=tässä_on_oikea_API_key

3. Jos et käytä gunshippiä vaan paikallista tietokantaa, avaa Sequel Pro, luo tyhjä tietokanta, sitten lataa työkaverilta saamasi tietokanta sisään valikosta File > Import.

4. Seuraavaksi haetaan riippuvuudet ajamalla projektin juuressa:

composer install && npm install

5. Sitten teeman riippuvuudet menemällä teemakansioon cd ~/Projects/projektinnimi/content/themes/teemannimi ja ajamalla npm install

6. Sitten asetetaan manuaalisesti /etc/hosts -tiedostoon projektin isäntärivi, jotta kehityspalvelin osaa yhdistää oikeaan projektiin, esimerkiksi suoraan komentoriviltä muokkaamalla sudo nano /etc/hosts ja antamalla oman pääkäyttäjän salasana. IP on Duden vagrant-koneella (digitoimistodude/marlin-vagrant) 10.1.2.4 ja Duden natiivilla macOS LEMPillä (digitoimistodude/macos-lemp-setup) 127.0.0.1. Tällöin lisää hosts tiedostoon viimeiselle riville seuraavasti (IP sen mukaan mitä käytät ja projektiosoite sen mukaan mikä on käytössä):

127.0.0.1 projektinnimi.test

Jos käytössä on vagrant (digitoimistodude/marlin-vagrant), lisää vhosts-kansioon tiedosto projekti.test (jos projektisi nimi on ”projekti”), jonne sisältö:

server {
    listen 80;
    include php7.conf;
    include global/wordpress.conf;
    root /var/www/projekti;
    index index.html index.htm index.php;
    server_name projekti.test;
}

Jos taas LEMP (digitoimistodude/macos-lemp-setup), muokkaa komentoriviltä sudo nano /etc/nginx/sites-available/projekti.test ja lisää yllä oleva sinne. Linkitä se sitten päällä olevaksi saitiksi aivan kuten tekisit tuotantopalvelimellakin, komennolla sudo ln -s /etc/nginx/sites-available/projekti.test /etc/nginx/sites-enabled/projekti.test. Sen jälkeen käynnistä web-palvelin uudelleen komennolla nginx.restart.

Huom. Ylläolevat tukeutuvat täysin siihen, että olet esimerkiksi noudattanut vagrant-boksimme asennusohjeita (digitoimistodude/marlin-vagrant) tai asentanut LEMP-web-palvelimemme oikeaoppisesti (digitoimistodude/macos-lemp-setup) JA lisännyt myös aliakset tämän sivun pohjalta.

7. Aseta mediakansio paikalleen Resilio Syncillä (olet saanut projektin aloittajalta linkin tai zip-tiedoston) projektikansion alle media/ -hakemistoon.

8. Luo itsellesi branch, katso ohjeet tästä.

9. Luo itsellesi WordPress-tunnus, aja wp-cli projektikansiossa (täydennä tähän komentoon tietosi): ./vendor/wp-cli/wp-cli/bin/wp user create etunimi nimesi@dude.fi --role=administrator --user_pass=TÄHÄN_ONEPASSWORDILLA_GENEROITU_VAIKEA_SALASANA --first_name=Etunimi --last_name=Sukunimi --display_name=Etunimi

Näin projektin kollaboraatio saa alkaa!

Lisää git-käytänteistä.