Skip to content
This repository was archived by the owner on Apr 18, 2024. It is now read-only.

Getting started

Jump to bottom
Pavel Skipenes edited this page Aug 23, 2022 · 25 revisions

This guide will help you to set up your development environment so you can start development as soon as possible.

The code base is being run inside a docker container that contains all the packages. This is recommended because you will not trash your computer with a ton of programs and the development environment will stay the same across different systems. This project has been tested on Arch Linux based distributions and Mac OS with both x86_64 and Arm architectures.

First installation

Prerequisites

IDE

The project has been developed with Visual Studio Code and Insomnia. These can be installed through brew on Mac OS and through Flathub on Linux.

# Mac OS
brew install --cask visual-studio-code insomnia
# Arch Linux
paru -Syu visual-studio-code-bin
flatpak install rest.insomnia.Insomnia

Packages

# Mac OS
brew install --cask git docker docker-compose
# Arch Linux
pacman -Syu git docker docker-compose
sudo -aG docker $USER

After installing docker make sure to start the docker service. On Mac OS open docker app. On Linux run systemctl start docker.

Installation

Steps are the same for Mac OS and Arch Linux

git clone git@github.com:NTNUI/org.ntnu.svommer.git
cd org.ntnu.svommer
git checkout rewrite
cp .env.example .env # open .env file and check that all variables are set
cp -r FRONTEND_EXPORT public # copy export from static site generator
docker-compose up

note that latest development is happening in rewrite branch. FRONTEND_EXPORT is a path to static site export.

see also https://github.com/Sigevio/ntnui-swimming-frontend for instructions on how to export a static site build

Overview

  • api is available at https://127.0.0.1/api
  • if you have exported static site to /public then that will be loaded on any request that is not directed to API
  • phpmyadmin is available at http://127.0.0.1:42069 to inspect database. Default credentials are admin, testing_password
  • containers will store runtime data on /docker/storage. To reset container data delete that directory.

Update API keys

Take a look at credentials wiki page for more info about API keys. Without API keys certain features will not be available.

Clone this wiki locally