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.

Sign up for GitHub

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

(2023-minimal changes) Update requirements and Readme #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(2023-minimal changes) Update requirements and Readme #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ An experiment combining [Django](https://www.djangoproject.com/) and [FastAPI](h
First create a virtual environment and install the dependencies:

```shell
python -m .venv venv
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
```
Expand All @@ -37,15 +37,21 @@ Then populate the initial database tables using the migration command:

## Running the application locally

(Don't forget to) Create a Superuser:
```shell
./manage.py createsuperuser
```

Run the server locally using `uvicorn`:

```shell
uvicorn aeroplane.main:app --debug
uvicorn aeroplane.main:app
```

The [auto-generated docs](https://fastapi.tiangolo.com/features/#automatic-docs) proivded by FastAPI are available at http://localhost:8000/docs
The [model admin](https://docs.djangoproject.com/en/4.2/ref/contrib/admin/) provided by Django is availabe at http://localhost:8000/dj/admin


The [model admin](https://docs.djangoproject.com/en/3.1/ref/contrib/admin/) provided by Django is availabe at http://localhost:8000/dj/admin
The [auto-generated docs](https://fastapi.tiangolo.com/features/#automatic-docs) provided by FastAPI are available at http://localhost:8000/docs

## Deploying to AWS Lambda & API Gateway

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ djantic
pytest
pytest-django
python-dotenv

uvicorn
# Only required for serverless deployment
mangum

Expand Down