Skip to content

Commit cd539c5

Browse files
committedDec 27, 2022
Update README.md
1 parent a3c5459 commit cd539c5

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed
 

‎README.md

+36
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ This project is a comprehensively updated fork of [Sebastián Ramírez's](https:
88

99
Generate a backend and frontend stack using Python, including interactive API documentation.
1010

11+
- [Screenshots](#screenshots)
12+
- [Key features](#key-features)
13+
- [How to use it](#how-to-use-it)
14+
- [Generate passwords](#generate-passwords)
15+
- [Input variables](#input-variables)
16+
- [Local development](#local-development)
17+
- [Starting Jupyter Lab](#starting-jupyter-lab)
18+
- [How to deploy](#how-to-deploy)
19+
- [More details](#more-details)
20+
- [Release notes](#release-notes)
21+
- [License](#license)
22+
23+
## Screenshots
24+
1125
### App landing page
1226

1327
[![API docs](img/landing.png)](https://github.com/whythawk/full-stack-fastapi-postgresql)
@@ -155,6 +169,28 @@ You can then view the frontend at `http://localhost:3000` and the backend api en
155169

156170
FastAPI `backend` updates will refresh automatically, but the `celeryworker` container must be restarted before changes take effect.
157171

172+
### Starting Jupyter Lab
173+
174+
If you like to do algorithmic development and testing in Jupyter Notebooks, then launch the `backend` terminal and start Jupyter as follows:
175+
176+
```bash
177+
docker-compose exec backend bash
178+
```
179+
180+
From the terminal:
181+
182+
```bash
183+
$JUPYTER
184+
```
185+
186+
Copy the link generated into your browser and start.
187+
188+
**NOTE:** Notebooks developed in the container are not saved outside, so remember to copy them for persistence. You can do that from inside Jupyter (download), or:
189+
190+
```bash
191+
docker cp <containerId>:/file/path/within/container /host/path/target
192+
```
193+
158194
## How to deploy
159195

160196
This stack can be adjusted and used with several deployment options that are compatible with Docker Compose, but it is designed to be used in a cluster controlled with pure Docker in Swarm Mode with a Traefik main load balancer proxy handling automatic HTTPS certificates, using the ideas from <a href="https://dockerswarm.rocks" target="_blank">DockerSwarm.rocks</a>.

0 commit comments

Comments
 (0)
Please sign in to comment.