Add metadata
This commit is contained in:
parent
436543c851
commit
dd40c6b380
|
@ -0,0 +1,25 @@
|
||||||
|
# Example Banjo app
|
||||||
|
|
||||||
|
[Banjo](https://django-banjo.readthedocs.io) i
|
||||||
|
|
||||||
|
Banjo is an abstraction over [Django](https://www.djangoproject.com/) which
|
||||||
|
provides a simplified subset of Django’s functionality, meant for beginners.
|
||||||
|
|
||||||
|
A Banjo app consists of two files, `models.py` and `views.py`, within a directory
|
||||||
|
called `app`. The app is run by calling `banjo`.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
If you want to run this app on your computer, first install [poetry](https://python-poetry.org/).
|
||||||
|
Then open Terminal and run the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cd ~/Desktop
|
||||||
|
$ git clone https://git.makingwithcode.org/archive/banjo-demo.git
|
||||||
|
$ cd banjo-demo
|
||||||
|
$ poetry install
|
||||||
|
$ poetry run banjo
|
||||||
|
```
|
||||||
|
|
||||||
|
Your Terminal is now serving the riddle app. Open `http://localhost:8000/api` to see
|
||||||
|
the automatically-generated API pages.
|
|
@ -0,0 +1,19 @@
|
||||||
|
[project]
|
||||||
|
name = "banjo-example"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "A small but complete example of a Banjo app."
|
||||||
|
license = {text = "MIT"}
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.10,<4.0"
|
||||||
|
dependencies = [
|
||||||
|
"django-banjo (>=0.9.1,<0.10.0)",
|
||||||
|
"fuzzywuzzy (>=0.18.0,<0.19.0)"
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
[build-system]
|
||||||
|
requires = ["poetry-core>=2.0.0,<3.0.0"]
|
||||||
|
build-backend = "poetry.core.masonry.api"
|
||||||
|
|
||||||
|
[tool.poetry]
|
||||||
|
package-mode = false
|
Loading…
Reference in New Issue