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

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

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tobi-de/onstock
• Owner: Tobi-De
• Created: 2024-08-20T09:50:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-18T17:18:30.000Z (11 months ago)
• Last Synced: 2024-12-14T08:18:58.511Z (10 months ago)
• Language: HTML
• Size: 220 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# onstock

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

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

## Prerequisites

- `Python 3.11+`

- [hatch 1.9.1+](https://hatch.pypa.io/latest/)

- [just](https://github.com/casey/just)

## Development

### Setup project

Ensure that the Python version specified in your `.pre-commit-config.yaml` file aligns with the Python in your virtual environment.

Hatch can [manage your python installation](https://hatch.pypa.io/latest/tutorials/python/manage/) if needed.

If this is a newly created project, run `git init && git add -A` first.

```shell

just setup

```

Read the content of the justfile to understand what this command does. Essentially, it sets up your virtual environment,

installs the dependencies, runs migrations, and creates a superuser with the credentials `admin@localhost` (email) and `admin` (password).

### Run the django development server

```shell

just server

```

> [!TIP]

> Run `just` to see all available commands.