Add README.md
This commit is contained in:
parent
70474060e7
commit
0db7c55744
28
README.md
Normal file
28
README.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# Barn Django App
|
||||
|
||||
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
|
||||
Loading…
Reference in a new issue