41 lines
1.8 KiB
Markdown
41 lines
1.8 KiB
Markdown
# Barn Django App
|
|
|
|
A collection of web-apps for my family's personal use, including a recipe database.
|
|
|
|
Django project for the Barn web-app.
|
|
|
|
This project is in early development and is by far not suitable, much less safe,
|
|
to run in production.
|
|
|
|
## Quick Start
|
|
|
|
> This section is more or less copied from
|
|
[Django Local Library](https://github.com/mdn/django-locallibrary-tutorial)
|
|
|
|
To get this project up and running locally on your computer:
|
|
|
|
1. Set up the [Python development environment](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/development_environment).
|
|
It is recommended to use a Python virtual environment.
|
|
> This has been tested against Django 4.1.4 (and may not work or be "optimal" for other versions).
|
|
1. Assuming you have Python setup, run the following commands (if you're on Windows
|
|
you may use `py` or `py -3` instead of `python` to start Python):
|
|
|
|
pip3 install -r requirements.txt
|
|
python3 manage.py makemigrations
|
|
python3 manage.py migrate
|
|
python3 manage.py createsuperuser # Create a superuser
|
|
python3 manage.py runserver
|
|
|
|
1. Open http://127.0.0.1:8000 and log in with your username and password
|
|
1. You can now create objects and view them
|
|
|
|
---
|
|
|
|
Copyright © 2023 Benjamin Stadlbauer
|
|
|
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
|
|
|
This program comes with a copy of the GNU Affero General Public License which is the [LICENSE.md](LICENSE.md) file at the root of this project.
|