Hemsidan - Server

Server-sidan av Fysiksektionens hemsida är byggd i python med web frameworket Django. Vi arbeter med Django och Django REST Framework för att bygga ett API för det som fontend i form av React, React Native eller annan frontend ska kunna kommunicera med.

Ladda ner och kör servern lokalt

För att ladda ner och köra servern lokalt behöver du sätta upp en del grejer. Följ stegen nedan för den miljö du programmerar i. Ett tips är att använda IDEn PyCharm. Vi får betal-varianten från KTH och den är väldigt väl anpassad för att jobba med Django. Nedan följer hur du sätter upp servern med och utan PyCharm. Om du inte ska redigera så mycket utan endast vill kunna starta servern kanske det är mer värt att inte köra på PyCharm.

Unix-baserade system (Utan PyCharm)

1. Klona repot med git clone [email protected]:Fysiksektionen/Hemsida.git.

2. Installera och sätt upp databasen i mysql genom att köra (notera att det går att ändra ''fdev'' och ''password'' till vad du vill):

   1. sudo apt update
   2. sudo apt install mariadb-server
   3. sudo mysql_secure_installation (följ instruktioner för att sätta upp ett lösenord för root).
   4. sudo mysql
   5. CREATE USER 'fdev'@'localhost' IDENTIFIED BY 'password';
   6. CREATE DATABASE hemsidan_db CHARACTER SET utf8mb4;
   7. GRANT ALL PRIVILEGES ON hemsidan_db.* TO 'fdev'@'localhost';
   8. FLUSH PRIVILEGES;
   9. exit;

3. Försäkra dig om att du har en ganska ny version av python3 (>3.5) och att du har pip installerat för den pythoninstallationen. (Notera att pip ibland är koplat till python2.7 och att du ska använda pip3. Det är viktigt att du använder en python3 installation!). Kör sudo apt-get install -y python3-venv. Navigera in i 'server'-mappen och kör python3 -m venv venv/.

4. Kör echo 'export PYTHONPATH="$PYTHONPATH:$VIRTUAL_ENV/.."' >> venv/bin/activate. Sedan source venv/bin/activate (Det aktiverar din virtual enviroment, något du måste göra varje gång du vill starta servern!)

5. Installera alla python-paket genom att använda pip install -r requirements.txt. (Notera att det ska vara pip här.)

6. Kopiera filen server/project_settings/settings/local_template.py till server/project_settings/settings/local.py och fyll i informationen baserat på användarnamn och dylikt som du använder under steg 1 och 2.

7. Nu är vi redo att sätta upp det sista i Django. Kör följande från server-mappen

   1. python scripts/manage.py collectstatic
   2. python scripts/manage.py makemigrations
   3. python scripts/manage.py migrate
   4. python scripts/manage.py createsuperuser (Följ instruktionerna. Här får du välja själv vilka inloggningsdetaljer du ska ha. 'admin' är ett passand användarnamn.)

8. Nu är du klar! Starta servern i development-mode genom att köra: python scripts/manage.py runserver 127.0.0.1:8000. Du kan nu anropa servern via ip-adressen 127.0.0.1:8000. Servern görs i development-läge.

Unix-baserade system (med PyCharm)

1. Genomför steg 1. och 2. från "Unix-baserade system" ovan.

2. Öppna 'server'-mappen med PyCharm. För att skapa en egen vitual enviroment; gå till File -> Settings -> Project: server -> Python interpreter -> [kugghjulet] -> Add -> [Använd standard-inställningarna för Virtualenv Enviroment och tryck ok].

3. Börja med att installera alla pythonpaket som behövs. Det gör du genom att i nedre högra hörnet välja en python-interpreter som du nu skapat. Sedan öppnar du terminalen i PyCharm (det bör då stå (venv) innan prompten). Kör pip install -r requirements.txt.

4. Kopiera filen server/project_settings/settings/local_template.py till server/project_settings/settings/local.py och fyll i informationen baserat på användarnamn och dylikt som du använder under steg 1 och 2.

5. Nu ska vi sätta upp Django i PyCharm. Gå till _File -> Settings -> Languages & Frameworks -> Django. Checka i 'Enable Django Support'. Ställ sedan in följande:

   • Django project root: Välj 'server'-mappen
   • Settings: välj "project_settings/settings/development.py"
   • Manage script: välj "scripts/manage.py"

6. När du sparat inställningarna borde du kunna verifiera att saker funkar genom att faktiskt se saker på knappen "Show structure".

7. Sätt upp run-kommandot genom att trycka på "Add configuration" i över högra hörnet. Lägg till en 'Django server' configuration. Viktigt är att du väljer rätt interpreter och att du lägger till "DJANGO_SETTINGS_MODULE=project_settings.settings.development" under Enviroment variables (variablerna skiljs med semikolon).

8. Nu ska vi bygga databasen. Välj Tools -> Run manage.py Task. Du får en prompt. Kör följande

   1. collectstatic
   2. makemigrations
   3. migrate
   4. createsuperuser (Följ instruktionerna. Här får du välja själv vilka inloggningsdetaljer du ska ha. 'admin' är ett passande användarnamn.)

9. Nu är du klar! Starta servern i development-mode genom att trycka på play-knappen.

Windows (med PyCharm)

1. Öppna PyCharm och välj "Get from VCS". Logga in med Github och ladda ned projektet.

2. Ladda ned MariaDB (open source MySQL-databas) från downloads.mariadb.org/mariadb/. Följ installeringen.

3. Öppna det nya programmet "MySQL Client". Du bör få en terminal med prompten MariaDB [(None)]> när du angivit lösenord. Skriv samma kommandon som listas som punkterna 5-9 under punkt 2 i "Unix-baserade system (utan PyCharm)".

4. Följ instruktion 2 - 7 i "Unix-baserade system (med PyCharm)".

Jobba med Migrations i VSC

Migrations är filer eller rättare sagt instruktioner som berättar hur databasen ska byggas upp. Dessa genereras automatiskt från hur modellerna är skrivna. Se mer här: Django - Migrations.

Filerna bygger på varandra och bygger upp en logisk följd av instruktioner för att återskapa det nuvarande tillståndet. Eftersom vi jobbar parallellt finns det risk att dessa inte längre har en logisk följd.

Squash migration per app per pull-request.

I normalfallet kommer endast en person jobba åt gången på varje branch. Det gör att under utvecklingsfasen av en branch får det finnas flera nyskapade och trackade migrations. Dessa migrations kan heta vad som helst och det smidigaste är att låta Django autogenerera namnet.

När utvecklingen sedan är färdig och det är dags att skapa en pull-request så ska alla de migrations som ha skapats sedan senaste synkning med main squashas ihop till en migration. Denna ska namnet <branch-name>_YYYYMMDD.py. Detta görs med:

python manage.py squashmigrations <appname> <start_migration_name> <migration_name> --squashed-name=<branch-name>_YYYYMMDD

Exempelvis python manage.py squashmigrations website 0001 0004 --squashed-name=backend-menu-model_20210203

Slutligen ska du verifiera att din nya migration fungerar som tänkt. Det kan du göra genom att migrera tillbaka till den senaste migrationen innan din branch med python manage.py migrate <appname> <migration_to_revert_to>. Och sedan köra migrate.

Använda locale och gettext

Vad är locale?

Locale är ett sammanfattande ord för allt som skiljer sig beroende på vilket språk användaren har valt. Det handlar om allt från faktiskt språk på text till format på datum.

Locale kommer att vara viktigt i backenden när det kommer till felmeddelanden och feedback till frontenden när objekt försöker ändras på felaktigt sätt. Sannolikt kommer frontenden i vissa fallt att visa felmeddelandet för användaren och då måste en korrekt översättning göras.

gettext för att översätta

Django har ett inbyggt system för att det ska ske smidigt. Det bygger på att alla texter som ska översättas körs genom en funktion, gettext. Exempelvis såhär:

from django.utils.translation import gettext

def raise_in_correct_lang():
   raise ValidationError(gettext("Text that can be translated"))

Detta har två problem.

1. Det är jobbigt att skriva en funktion kring alla strängar. Lösningen är att importera funktionen med namnet _. Då blir koden ovan som följer:

from django.utils.translation import gettext as _

def raise_in_correct_lang():
   raise ValidationError(_("Text that can be translated"))

2. Vissa strängar utvärderas inte när ett anrop görs, utan tidigare när Django laddas. Exempelvis textsträngar i Models. Lösningen är att använda funktionen gettext_lazy. Då utvärderas strängen så sent som möjligt.

Django messages

Eftersom översättningar sällan blir så bra så har Django ett system för oss att explicit specificera alla översättningar. Detta görs genom att manuellt fylla i översättningar i filer som Django genererar.

python manage.py makemessages -l sv --ignore venv --no-wrap --no-obsolete skapar översättningsfiler (.po) i mapparna locale/sv som finns i varje app. Dessa ska sedan redigeras manuellt.

python manage.py compilemessages kompilerar locale-filerna till mer effektiva filer (.mo). Dessa ska inte redigeras manuellt.

adminsortable Swedish translation

För att få svensk översättning till paketet adminsortable så ska du kopiera mappen /locale/sv/LC_MESSAGES_adminsortable/ till /venv/lib/python3.X/site-packages/adminsortable/locales/sv/LC_MESSAGES

Därefter kan du köra python manage.py compilemessages