This repository contains the source code for KSG's web page. The project is written in Django exposing a graphQL API using graphene. KSG-nett is a two-part webapplication, this being the backend and requires a fucntioning frontend instance to be running. Follow the link and the quickstart section over there in addition to here to get everything up and running.
Dependencies are managed with poetry. To run the code do the following
- Make sure you have python 3.8 available on the computer
- install poetry on your computer
- Install Weasyprint (make sure to follow instructions thoroughly before going on to the next step)
- Clone and Navigate to this folder
- Install the dependencies by running
poetry install - Migrate the database with
poetry run python manage.py migrate - Run the projects by running
poetry run python manage.py runserver
We use black as a code formatter. We enforce this with the use pre-commit. Make sure to have this installed locally otherwise code formatting will not be automaically applied.
Usually tasks are assigned through Shortcut stories, with a story type which is either a feature, bug or chore, and a story id. This is used to track progress on the task throughout development. A given branch will automatically get tracked if the branch includes sc-<story-id> anywhere in its name.
- Our branches follows a convention of
story-type/sc-<story-id>/branch-name
So a story which is a bug type, with an id of 666 and a title of "Dashboard renders wrong data" would be named bug/sc-666/dashboard-renders-wrong-data or similar.