Startinstruktioner

Översikt

_{Följande behövs för att kunna köra applikationen lokalt:}

• _{Ett projekt hos Google.}
• _{En .env fil med korrekta variabler inlagda.}
• _{Docker installerat.}
• _{En nedklonad kopia av projektet.}

_{För att starta upp projektet, gör följande:}

• _{Klona ned projektet från master med kommandot git clone https://github.com/1dv611-futurum-project/futurum-project.}
• _{Sätt upp ett projekt hos google.}
• _{Initiera .env-filen och placera den i foldern /services/node, bredvid package.json.}
• _{Installera Docker.}
• _{Starta projektet med docker-compose, stående i projektets rot-folder.}

För utveckling

_{För att komma igång med utveckling av applikationen, följ instruktionerna för uppstart av projektet enligt ovan. Öppna källkoden i valfri utvecklingsmiljö. Följ sedan processen som beskriven under arbetsprocessen, samt använd dig av relevanta docker-kommandon. För utveckling på klienten kan det vara värt att notera att startkommandot i Dockerfilen på client-branchen är anpassat för utveckling, och startar applikationen från react-dev-server med hot-reload aktiverat.}

Sätt upp ett projekt hos Google

_{Logga först in på valfritt Google-konto och navigera till [Google Cloud Platform (https://console.cloud.google.com/). Följ sedan följande instruktioner:}

_{1. Acceptera Terms of Service:}

_{2. Välj "Select a project":}

_{3. Tryck på plusset för att skapa ett nytt projekt:}

_{4. Dör projektet till varlfritt namn och välj "Create":}

_{Aktivera Google+ och Gmail APIerna genom att gå till projektets Dashboard, välja 'Enable APIs and Services', söka upp Gmail och Google+ och aktivera dem:}

_{5. Gå till projektets Dashboard:}

_{6. Välj ditt projekt:}

_{7. Välj 'Enable APIs and Services':}

_{8. Sök upp Gmail och välj "Enable" för att aktivera:}

_{9. Upprepa steg 8 för att aktivera även Google+.}

_{10. Tryck på nyckeln för att skapa credentials för projektet och välj "Create credentials":}

_{11. Välj "Help me choose":}

_{12. Fyll i alternativ som nedan och välj "What credentials do I need?":}

_{13. Fyll i http://127.0.0.1:8080/node/auth/google/callback som Authorized redirect URIs och välj Create ClientID:}

_{14. Fyll i valfri mailadress och namn här:}

_{15. Välj "I'll do this later" på frågan om du vill ladda ner credentials:}

_{16. Välj istället namnet på dina credentials:}

_{17. Och notera "Client ID" och "Client secret" härifrån:}

Initiera .env-filen

• _{Gå till mappen /services/node i projektet.}
• _{Skapa en fil som heter .env (notera punkten).}
• _{Spara filen med följande variabler inlagda:}

IMAP_USER=[Den mailadress du vill koppla upp applikationen mot för att ta emot mail.]
IMAP_FORWARDING_ADDRESS=[Den mailaddress du vill ha mail vidarebefodrade till, när sådan funktionalitet är påkallad.]
IMAP_REDIRECT_URL=http://127.0.0.1:8080/node/auth/google/callback
IMAP_CLIENT_ID=[Ditt noterade Client ID från Google-projektet ovan.]
IMAP_CLIENT_SECRET=[Din noterade Client secret från Google-projektet ovan.]