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


```shell
python -m venv venv
source venv/bin/activate # Use the appropiate other binary if not on linux
Copy link
Collaborator

Choose a reason for hiding this comment

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

source venv/bin/activate # Linux and MacOS
# venv\Scripts\activate # Windows


#### User fixtures

In development mode you can switch between the pre-defined user fixtures with a button in the context menu at the top right of the web page. **Bob** is a superuser and has access to the [Django admin page](http://127.0.0.1:8000/admin/) and **Perry** is a staff member. The other users have [different access to the first example organization](http://127.0.0.1:8000/organizations/1/admin/) provided by the fixture. Follow the provided links for more info.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(usr: bob, passwd: bob)
Würd ich noch dazuschreib. Schon irgendwie logisch, aber hab auch erstmal Bob anstellt von bob probiert


This software depends on python and its package index. The pip dependencies are listed in [requirements.txt](requirements.txt).

##### Using venv
Copy link
Collaborator

Choose a reason for hiding this comment

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

Zwischenüberschrift verwirrt, weil man sich nicht sicher ist, ob das jetzt was Neues ist und ob man die requirements schon installiert haben soll.

```shell
python -m venv venv
source venv/bin/activate # Use the appropiate other binary if not on linux
pip install -r requirements.txt
Copy link
Collaborator

@mfbehrens mfbehrens Oct 30, 2024

Choose a reason for hiding this comment

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

It is recomended to use pyproject.toml

-> pip install .

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