banjo-demo/README.md

25 lines
778 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Example Banjo app
[Banjo](https://django-banjo.readthedocs.io) is an abstraction over
[Django](https://www.djangoproject.com/) which provides a simplified subset
of Djangos 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.