Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description and settings for a dev setup #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hd1ex
Copy link
Collaborator

@hd1ex hd1ex commented Oct 29, 2024

No description provided.

@hd1ex
Copy link
Collaborator Author

hd1ex commented Oct 29, 2024

The rendered new README can be previewed at https://github.com/hd1ex/shiftings/tree/dev-setup.
Can you also reproduce this dev setup on your machines using a fresh git clone?

Copy link
Collaborator

@mfbehrens mfbehrens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, minor suggestions

@hd1ex hd1ex force-pushed the dev-setup branch 2 times, most recently from f5e8b7b to 174a4c5 Compare February 14, 2025 14:16
@hd1ex hd1ex requested a review from mfbehrens February 14, 2025 14:17
Copy link
Collaborator

@mfbehrens mfbehrens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest looks good

README.md Outdated

#### Database setup

The script [setup_db.py](setup_db.py) initializes your database with the schema matching the shiftings models (running `manage.py migrate`) and [loading the fixtures](https://docs.djangoproject.com/en/5.1/howto/initial-data/) providing example data. Execute it for having a local database:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now this is setup_db.sh

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mich triggert es außerdem, dass da so viel Text und so viele Befehle stehen, weil mein ADHS Gehirn gerne einfach alle Commands die es sieht, einfach in ne Commandline reinhauen will, aber man eigentlich nur den untersten brauch.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Das Dokument ist so aufgebaut, dass man die von Github hervorgehobenen Befehle ausführen muss, um ein sinnvolles Setup zu bekommen. Wir kennen alle Python und manchmal funktioniert etwas nicht. Insbesondere deswegen finde ich es schon wichtig für die Leute auch hinzuschreiben, was abgeht. Außerdem gehe ich mal davon aus, dass nicht jeder Programmierer ein ADHS-Gehirn hat :)

Für deinen Vorschlag kann man entweder ein TLDR oben hinzufügen, den Stil des Dokuments wie ich oben gerade kurz einführen oder noch ein Skript machen. Mir egal wie, das sollte man aber dann in einem anderen Change machen. Lass das jetzt endlich mal mergen, wenn es inhaltlich passt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants