dsek-lth/frontend

Development

Prerequisites

• npm & node, for guide see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
• docker and docker-compose
• an ssh key registered with your Github account

Setup

When cloning the repository, clone with the --recurse-submodules flag to clone down the backend submodule as well. If you cloned normally, you can fix it after the fact with git submodule update --init --recursive. If this is not working, it may be because you do not have an ssh key registered with Github.

run npm install

Available Scripts

npm start - Runs react dev server and docker-composes back-end in parallel. You may have to run with sudo.

npm start-user-def - Runs react dev server with user specified docker-compose file. Path uses environment variable $GATEWAY_PATH.

npm start-use-existing - Runs react dev server with existing back-end already running.

Contribute

TODO

Deployment

TODO

Linter

TODO

Folder Structure Description

TODO

frontend's Issues

skapa evenemangskalender

Själva grafiska komponenten går att skapa utan att det finns backend stöd för funktionaliteten. Sättet man går till väga är att man hårdkodar lite statisk data som man tänker sig att man i framtiden hämtar från backend, och sen visualiserar man denna data.

skapa menystruktur

lägg till demokratiskt viktiga saker som styrdokument, möteshandlingar osv

Stydokument borde vi kunna länka mot https://github.com/Dsek-LTH/stadgar respektive https://github.com/Dsek-LTH/reglemente på något fiffigt sätt. Kanske att man använder sig av releases, kanske att man sätter upp en CI som bygger en ny pdf efter varje ny commit.

ta fram skisser på frontend

Någon form av designdokument att jobba mot hade varit najs. Gärna i något smidigt digitalt format så att det är lätt att itererera, men analogt funkar också.

lägg till information om olika mästerier

Räcker med hårdkodad text för tillfället. I framtiden kommer man nog vilja låta t.ex. mästaren för varje mästeri ändra texten dynamiskt, men det behöver vi inte bry oss om just nu.

gör om submodulen till https-länk

Just nu måste man ha en ssh-nyckel på github för att kunna hämta ner backend-submodulen, eftersom den är angiven med en ssh-länk istället för https. Detta gör att Travis inte kan klona ordentligt.
Iom att gateway är publik och man ändå inte bör göra ändringar/pusha från submodulen så tillför ssh inget i detta fallet.
I samband med att detta fixas borde man även ta bort alla omnämnanden av ssh-nycklar från README.

skapa nyhetsflöde

Själva grafiska komponenten går att skapa utan att det finns backend stöd för funktionaliteten. Sättet man går till väga är att man hårdkodar lite statisk data som man tänker sig att man i framtiden hämtar från backend, och sen visualiserar man denna data.