# SIKWEB 2.0

A modern web app using a Django backend and an Angular frontend.

## Components

### Infoscreen

Angular-based slideshow app for the guild room's screens.

### Member register

Data table app for viewing and modifying the member register, member applications and membership payments.

### Web app

Mostly static website with an event calendar and news feed.

## Accessing the source

### Clone this repository and enter it

Set up your SSH key authentication in GitLab Profile Settings. Then clone the repository and checkout the development branch:

```bash
git clone git@gitlab.com:sahkoinsinoorikilta/vtmk/web2.0-backend.git
cd web2.0-backend
git checkout develop
```

## Development

### Poetry

For depedencies and virtual environment, we use [poetry](https://python-poetry.org/). The easiest integration with VSCode is to have poetry install virtual environment in project folder, configured with

```bash
poetry config virtualenvs.in-project true
```

#### CMDs

Install dependencies

```bash
poetry install
```

Activate virtual environment in shell

```bash
poetry shell
```

### npm scripts

We use Node.js for few development tasks, like linting. Easiest way to install Node is [nvm](https://github.com/nvm-sh/nvm).

TODO: List scripts

### Initializing data

Run the following `manage.py` commands. Do not run these in production without thinking!

```bash
python manage.py createdefaultadmin  # creates an admin user
python manage.py initialize          # creates user groups
python manage.py createdummydata     # creates dummy members to the member register
```

### Running

```bash
python manage.py runserver 0.0.0.0:8000
```

Using address `0.0.0.0` will bind to all IP addresses. Using `localhost` will only bind to your machine.

#### Visit the page

Visit [https://localhost:8000](https://localhost:8000) in your browser!

### Development workflow

When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with `feature`.

Example of creating a feature branch:

```bash
git checkout -b feature-error-page
```

When your changes are ready and the code works without errors, submit a merge request to `develop` in GitLab.  Another developer reviews your changes and runs the merge. Feature branches should be closed on merge.

Bugfixes do not need their own feature branches and can be pushed straight to `develop`, but if the fix needs a notable amount of work, it should be done in a `bugfix` branch instead.

Merge requests to `master` should be reviewed by multiple developers. Only a moderator can accept merge requests to `master`.

### Linting

Lint python files using `pycodestyle` with

```bash
pycodestyle --config=pycodestyle.cfg --count .
```

Lint javascript and markdown using `eslint` and `remark` with

```bash
npm test
```

Use an editor with linting capabilities to write pretty code that passes linting. Examples include _VSCode_, _Atom_ and _Pycharm_.

### Unit tests

Run unit tests with

```bash
python manage.py test
```

Due to the mostly static nature of the project, most elements are difficult to properly unit test. If you write code with actual logic, make sure to write at least one unit or integration test that tests your code's core functionality.

Tests are located in `tests.py` under every subproject.

## Production

Project is run in production with Docker. See `Dockerfile` for details.

## GitLab CI

All pushed changes go through the GitLab Continuous Integration, which consists of automated unit testing and linting. Make sure your changes pass both before merging to `develop` or `master`.
