https://github.com/tobi-de/maskey

maskey
https://github.com/tobi-de/maskey

Last synced: about 1 month ago
JSON representation

maskey

• Host: GitHub
• URL: https://github.com/tobi-de/maskey
• Owner: Tobi-De
• Created: 2023-01-17T15:00:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-17T15:03:15.000Z (over 2 years ago)
• Last Synced: 2025-02-26T09:12:23.240Z (8 months ago)
• Language: Python
• Size: 425 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# maskey

[![fuzzy-couscous](https://img.shields.io/badge/built%20with-fuzzy--couscous-success)](https://github.com/Tobi-De/fuzzy-couscous)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Code style: djlint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://www.djlint.com)

[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)

## Prerequisites

- `Python 3.10+`

- `Poetry 1.2+`

- `Postgresql 10+`

## Development

### Create a new virtual environment

```shell

poetry shell

```

### Install dependencies

```shell

poetry install

```

### Install pre-commit

```shell

pre-commit install

```

### Run the django development server

```

poe r

```

[poethepoet](https://github.com/nat-n/poethepoet) is the task runner used here. To see all available commands read

 the `[tool.poe.tasks]`section of the `pyproject.toml` file or run `poe -h` to see the help page.

> **Note**: SITE_ID

>

> You may get an error when trying to login or signup, this is due to django-allauth, you need to create a new *site* in django

> admin and use its *ID* as the value of `SITE_ID` in the `settings.py`file.

> Create a new superuser with the `python manage.py createsuperuser` command, login to django admin then look for the `sites`

> section in the left navigation bar and create a new *site*.