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

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

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tobi-de/myjourney
• Owner: Tobi-De
• License: mit
• Created: 2024-01-18T14:16:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-06T23:59:47.000Z (over 1 year ago)
• Last Synced: 2025-07-17T11:02:09.868Z (3 months ago)
• Language: Python
• Size: 74.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# myjourney

[![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)

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

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

## Deploy

### VPS

### Ansible

### Caprover

- If you use github, instead of entering your password directly into the ``password`` field, you can use a `personal access token `__, which is a more secure option.

- Checkout `caprover automatic deploy `__ to automate the deployment of your applications.

   If you have generate a template with the ``falco`` cli or you have a dockerfile at your disposal, the only config you need in your projec to run caprover is this

```text

    {

       "schemaVersion": 2,

       "dockerfilePath": "./deploy/Dockerfile" # the path to your dockerfile

    }

```

open ssh console

```bash

docker exec -it $(docker ps --filter name=myjourney -q) /bin/sh

```

## Prerequisites

- `Python 3.11+`

- `hatch 1.9.1+`

- `Postgresql 13+`

## Development

### Create a new virtual environment

```shell

hatch shell

```

### Install pre-commit

```shell

git init && pre-commit install

```

Ensure that the Python version specified in your `.pre-commit-config.yaml` file aligns with the Python version installed on your system.

### Create a `.env` file

```shell

falco sync-dotenv

```

### Apply migrations

```shell

hatch run migrate

```

### Create a superuser

Fill the `SUPERUSER_EMAIL` and `SUPERUSER_PASSWORD` in your `.env` file and run:

```shell

falco make-superuser

```

### Run the django development server

```shell

hatch run runserver

# if you've aliased `hatch run` to `hr``

hr runserver

# if you've added falco-cli as a dependency to your project

falco work

```