Repository files navigation

• Docker.
• Docker Compose.
• Poetry for Python package and environment management.

• Start the stack with Docker Compose:

docker-compose up -d

• Now you can open your browser and interact with these URLs:

Frontend, built with Docker, with routes handled based on the path:http://localhost

Backend, JSON based web API based on OpenAPI:http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend):http://localhost/docs

Alternative automatic documentation with ReDoc (from the OpenAPI backend):http://localhost/redoc

PGAdmin, PostgreSQL web administration:http://localhost:5050

Flower, administration of Celery tasks:http://localhost:5555

Traefik UI, to see how the routes are being handled by the proxy:http://localhost:8090

Note: The first time you start your stack, it might take a minute for it to be ready. While the backend waits for the database to be ready and configures everything. You can check the logs to monitor it.

To check the logs, run:

docker-compose logs

To check the logs of a specific service, add the name of the service, e.g.:

docker-compose logs backend

If your Docker is not running inlocalhost (the URLs above wouldn't work) check the sections below onDevelopment with Docker Toolbox andDevelopment with a custom IP.

By default, the dependencies are managed withPoetry, go there and install it.

From./backend/app/ you can install all the dependencies with:

$poetry install

Then you can start a shell session with the new environment with:

$poetry shell

Next, open your editor at./backend/app/ (instead of the project root:./), so that you see an./app/ directory with your code inside. That way, your editor will be able to find all the imports, etc. Make sure your editor uses the environment you just created with Poetry.

Modify or add SQLAlchemy models in./backend/app/app/models/, Pydantic schemas in./backend/app/app/schemas/, API endpoints in./backend/app/app/api/, CRUD (Create, Read, Update, Delete) utils in./backend/app/app/crud/. The easiest might be to copy the ones for Posts (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in./backend/app/app/worker.py.

If you need to install any additional package to the worker, add it to the file./backend/app/celeryworker.dockerfile.

During development, you can change Docker Compose settings that will only affect the local development environment, in the filedocker-compose.override.yml.

The changes to that file only affect the local development environment, not the production environment. So, you can add "temporary" changes that help the development workflow.

For example, the directory with the backend code is mounted as a Docker "host volume", mapping the code you change live to the directory inside the container. That allows you to test your changes right away, without having to build the Docker image again. It should only be done during development, for production, you should build the Docker image with a recent version of the backend code. But during development, it allows you to iterate very fast.

There is also a command override that runs/start-reload.sh (included in the base image) instead of the default/start.sh (also included in the base image). It starts a single server process (instead of multiple, as would be for production) and reloads the process whenever the code changes. Have in mind that if you have a syntax error and save the Python file, it will break and exit, and the container will stop. After that, you can restart the container by fixing the error and running again:

$docker-compose up -d

There is also a commented outcommand override, you can uncomment it and comment the default one. It makes the backend container run a process that does "nothing", but keeps the container alive. That allows you to get inside your running container and execute commands inside, for example a Python interpreter to test installed dependencies, or start the development server that reloads when it detects changes, or start a Jupyter Notebook session.

To get inside the container with abash session you can start the stack with:

$docker-compose up -d

and thenexec inside the running container:

$docker-composeexec backend bash

You should see an output like:

root@7f2607af31c3:/app#

that means that you are in abash session inside your container, as aroot user, under the/app directory.

There you can use the script/start-reload.sh to run the debug live reloading server. You can run that script from inside the container with:

$bash /start-reload.sh

...it will look like:

root@7f2607af31c3:/app#bash /start-reload.sh

and then hit enter. That runs the live reloading server that auto reloads when it detects code changes.

Nevertheless, if it doesn't detect a change but a syntax error, it will just stop with an error. But as the container is still alive and you are in a Bash session, you can quickly restart it after fixing the error, running the same command ("up arrow" and "Enter").

...this previous detail is what makes it useful to have the container alive doing nothing and then, in a Bash session, make it run the live reload server.

To test the backend run:

$DOMAIN=backend sh ./scripts/test.sh

The file./scripts/test.sh has the commands to generate a testingdocker-stack.yml file, start the stack and test it.

The tests run with Pytest, modify and add tests to./backend/app/app/tests/.

If you use GitLab CI the tests will run automatically.

Start the stack with this command:

DOMAIN=backend sh ./scripts/test-local.sh

The./backend/app directory is mounted as a "host volume" inside the docker container (set in the filedocker-compose.dev.volumes.yml).You can rerun the test on live code:

docker-composeexec backend /app/tests-start.sh

If your stack is already up and you just want to run the tests, you can use:

docker-composeexec backend /app/tests-start.sh

That/app/tests-start.sh script just callspytest after making sure that the rest of the stack is running. If you need to pass extra arguments topytest, you can pass them to that command and they will be forwarded.

For example, to stop on first error:

docker-composeexec backend bash /app/tests-start.sh -x

Because the test scripts forward arguments topytest, you can enable test coverage HTML report generation by passing--cov-report=html.

To run the local tests with coverage HTML reports:

DOMAIN=backend sh ./scripts/test-local.sh --cov-report=html

To run the tests in a running stack with coverage HTML reports:

docker-composeexec backend bash /app/tests-start.sh --cov-report=html

If you know about PythonJupyter Notebooks, you can take advantage of them during local development.

Thedocker-compose.override.yml file sends a variableenv with a valuedev to the build process of the Docker image (during local development) and theDockerfile has steps to then install and configure Jupyter inside your Docker container.

So, you can enter into the running Docker container:

docker-composeexec backend bash

And use the environment variable$JUPYTER to run a Jupyter Notebook with everything configured to listen on the public port (so that you can use it from your browser).

It will output something like:

root@73e0ec1f1ae6:/app#$JUPYTER[I 12:02:09.975 NotebookApp] Writing notebook server cookie secret to /root/.local/share/jupyter/runtime/notebook_cookie_secret[I 12:02:10.317 NotebookApp] Serving notebooks from local directory: /app[I 12:02:10.317 NotebookApp] The Jupyter Notebook is running at:[I 12:02:10.317 NotebookApp] http://(73e0ec1f1ae6 or 127.0.0.1):8888/?token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397[I 12:02:10.317 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).[W 12:02:10.317 NotebookApp] No web browser found: could not locate runnable browser.[C 12:02:10.317 NotebookApp]    Copy/paste this URL into your browser when you connect for the first time,    to login with a token:        http://(73e0ec1f1ae6 or 127.0.0.1):8888/?token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397

you can copy that URL and modify the "host" to belocalhost or the domain you are using for development (e.g.local.dockertoolbox.tiangolo.com), in the case above, it would be, e.g.:

http://localhost:8888/token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397

and then open it in your browser.

You will have a full Jupyter Notebook running inside your container that has direct access to your database by the container name (db), etc. So, you can just run sections of your backend code directly, for example withVS Code Python Jupyter Interactive Window orHydrogen.

As during local development your app directory is mounted as a volume inside the container, you can also run the migrations withalembic commands inside the container and the migration code will be in your app directory (instead of being only inside the container). So you can add it to your git repository.

Make sure you create a "revision" of your models and that you "upgrade" your database with that revision every time you change them. As this is what will update the tables in your database. Otherwise, your application will have errors.

• Start an interactive session in the backend container:

$docker-composeexec backend bash

• If you created a new model in./backend/app/app/models/, make sure to import it in./backend/app/app/db/base.py, that Python module (base.py) that imports all the models will be used by Alembic.

• After changing a model (for example, adding a column), inside the container, create a revision, e.g.:

$alembic revision --autogenerate -m"Add column last_name to User model"

• Commit to the git repository the files generated in the alembic directory.

• After creating the revision, run the migration in the database (this is what will actually change the database):

$alembic upgrade head

If you don't want to use migrations at all, uncomment the line in the file at./backend/app/app/db/init_db.py with:

Base.metadata.create_all(bind=engine)

and comment the line in the fileprestart.sh that contains:

$alembic upgrade head

If you don't want to start with the default models and want to remove them / modify them, from the beginning, without having any previous revision, you can remove the revision files (.py Python files) under./backend/app/alembic/versions/. And then create a first migration as described above.

If you are usingDocker Toolbox in Windows or macOS instead ofDocker for Windows orDocker for Mac, Docker will be running in a VirtualBox Virtual Machine, and it will have a local IP different than127.0.0.1, which is the IP address forlocalhost in your machine.

The address of your Docker Toolbox virtual machine would probably be192.168.99.100 (that is the default).

As this is a common case, the domainlocal.dockertoolbox.tiangolo.com points to that (private) IP, just to help with development (actuallydockertoolbox.tiangolo.com and all its subdomains point to that IP). That way, you can start the stack in Docker Toolbox, and use that domain for development. You will be able to open that URL in Chrome and it will communicate with your local Docker Toolbox directly as if it was a cloud server, including CORS (Cross Origin Resource Sharing).

If you used the default CORS enabled domains while generating the project,local.dockertoolbox.tiangolo.com was configured to be allowed. If you didn't, you will need to add it to the list in the variableBACKEND_CORS_ORIGINS in the.env file.

To configure it in your stack, follow the sectionChange the development "domain" below, using the domainlocal.dockertoolbox.tiangolo.com.

After performing those steps you should be able to open:http://local.dockertoolbox.tiangolo.com and it will be server by your stack in your Docker Toolbox virtual machine.

Check all the corresponding available URLs in the section at the end.

You might want to use something different thanlocalhost as the domain. For example, if you are having problems with cookies that need a subdomain, and Chrome is not allowing you to uselocalhost.

In that case, you have two options: you could use the instructions to modify your systemhosts file with the instructions below inDevelopment with a custom IP or you can just uselocalhost.tiangolo.com, it is set up to point tolocalhost (to the IP127.0.0.1) and all its subdomains too. And as it is an actual domain, the browsers will store the cookies you set during development, etc.

If you used the default CORS enabled domains while generating the project,localhost.tiangolo.com was configured to be allowed. If you didn't, you will need to add it to the list in the variableBACKEND_CORS_ORIGINS in the.env file.

To configure it in your stack, follow the sectionChange the development "domain" below, using the domainlocalhost.tiangolo.com.

After performing those steps you should be able to open:http://localhost.tiangolo.com and it will be server by your stack inlocalhost.

Check all the corresponding available URLs in the section at the end.

If you are running Docker in an IP address different than127.0.0.1 (localhost) and192.168.99.100 (the default of Docker Toolbox), you will need to perform some additional steps. That will be the case if you are running a custom Virtual Machine, a secondary Docker Toolbox or your Docker is located in a different machine in your network.

In that case, you will need to use a fake local domain (dev.example.com) and make your computer think that the domain is is served by the custom IP (e.g.192.168.99.150).

If you used the default CORS enabled domains,dev.example.com was configured to be allowed. If you want a custom one, you need to add it to the list in the variableBACKEND_CORS_ORIGINS in the.env file.

• Open yourhosts file with administrative privileges using a text editor:

  • Note for Windows: If you are in Windows, open the main Windows menu, search for "notepad", right click on it, and select the option "open as Administrator" or similar. Then click the "File" menu, "Open file", go to the directoryc:\Windows\System32\Drivers\etc\, select the option to show "All files" instead of only "Text (.txt) files", and open thehosts file.
  • Note for Mac and Linux: Yourhosts file is probably located at/etc/hosts, you can edit it in a terminal runningsudo nano /etc/hosts.

• Additional to the contents it might have, add a new line with the custom IP (e.g.192.168.99.150) a space character, and your fake local domain:dev.example.com.

The new line might look like:

192.168.99.100    dev.example.com

• Save the file.
  • Note for Windows: Make sure you save the file as "All files", without an extension of.txt. By default, Windows tries to add the extension. Make sure the file is saved as is, without extension.

...that will make your computer think that the fake local domain is served by that custom IP, and when you open that URL in your browser, it will talk directly to your locally running server when it is asked to go todev.example.com and think that it is a remote server while it is actually running in your computer.

To configure it in your stack, follow the sectionChange the development "domain" below, using the domaindev.example.com.

After performing those steps you should be able to open:http://dev.example.com and it will be server by your stack inlocalhost.

Check all the corresponding available URLs in the section at the end.

If you need to use your local stack with a different domain thanlocalhost, you need to make sure the domain you use points to the IP where your stack is set up. See the different ways to achieve that in the sections above (i.e. using Docker Toolbox withlocal.dockertoolbox.tiangolo.com, usinglocalhost.tiangolo.com or usingdev.example.com).

To simplify your Docker Compose setup, for example, so that the API docs (Swagger UI) knows where is your API, you should let it know you are using that domain for development. You will need to edit 1 line in 2 files.

• Open the file located at./.env. It would have a line like:

DOMAIN=localhost

• Change it to the domain you are going to use, e.g.:

DOMAIN=localhost.tiangolo.com

That variable will be used by the Docker Compose files.

• Now open the file located at./frontend/.env. It would have a line like:

VUE_APP_DOMAIN_DEV=localhost

• Change that line to the domain you are going to use, e.g.:

VUE_APP_DOMAIN_DEV=localhost.tiangolo.com

That variable will make your frontend communicate with that domain when interacting with your backend API, when the other variableVUE_APP_ENV is set todevelopment.

After changing the two lines, you can re-start your stack with:

docker-compose up -d

and check all the corresponding available URLs in the section at the end.

• Enter thefrontend directory, install the NPM packages and start the live server using thenpm scripts:

cd frontendnpm installnpm run serve

Then open your browser athttp://localhost:8080

Notice that this live server is not running inside Docker, it is for local development, and that is the recommended workflow. Once you are happy with your frontend, you can build the frontend Docker image and start it, to test it in a production-like environment. But compiling the image at every change will not be as productive as running the local development server with live reload.

Check the filepackage.json to see other available options.

If you have Vue CLI installed, you can also runvue ui to control, configure, serve, and analyze your application using a nice local web user interface.

If you are only developing the frontend (e.g. other team members are developing the backend) and there is a staging environment already deployed, you can make your local development code use that staging API instead of a full local Docker Compose stack.

To do that, modify the file./frontend/.env, there's a section with:

VUE_APP_ENV=development# VUE_APP_ENV=staging

• Switch the comment, to:

# VUE_APP_ENV=developmentVUE_APP_ENV=staging

If you are developing an API-only app and want to remove the frontend, you can do it easily:

• Remove the./frontend directory.
• In thedocker-compose.yml file, remove the whole service / sectionfrontend.
• In thedocker-compose.override.yml file, remove the whole service / sectionfrontend.

Done, you have a frontend-less (api-only) app. 🔥 🚀

If you want, you can also remove theFRONTEND environment variables from:

• .env
• .gitlab-ci.yml
• ./scripts/*.sh

But it would be only to clean them up, leaving them won't really have any effect either way.

You can deploy the stack to a Docker Swarm mode cluster with a main Traefik proxy, set up using the ideas fromDockerSwarm.rocks, to get automatic HTTPS certificates, etc.

And you can use CI (continuous integration) systems to do it automatically.

But you have to configure a couple things first.

This stack expects the public Traefik network to be namedtraefik-public, just as in the tutorials inDockerSwarm.rocks.

If you need to use a different Traefik public network name, update it in thedocker-compose.yml files, in the section:

networks:traefik-public:external:true

Changetraefik-public to the name of the used Traefik network. And then update it in the file.env:

TRAEFIK_PUBLIC_NETWORK=traefik-public

You need to make sure that each service (Docker container) that uses a volume is always deployed to the same Docker "node" in the cluster, that way it will preserve the data. Otherwise, it could be deployed to a different node each time, and each time the volume would be created in that new node before starting the service. As a result, it would look like your service was starting from scratch every time, losing all the previous data.

That's specially important for a service running a database. But the same problem would apply if you were saving files in your main backend service (for example, if those files were uploaded by your users, or if they were created by your system).

To solve that, you can put constraints in the services that use one or more data volumes (like databases) to make them be deployed to a Docker node with a specific label. And of course, you need to have that label assigned to one (only one) of your nodes.

For each service that uses a volume (databases, services with uploaded files, etc) you should have a label constraint in yourdocker-compose.yml file.

To make sure that your labels are unique per volume per stack (for example, that they are not the same forprod andstag) you should prefix them with the name of your stack and then use the same name of the volume.

Then you need to have those constraints in yourdocker-compose.yml file for the services that need to be fixed with each volume.

To be able to use different environments, likeprod andstag, you should pass the name of the stack as an environment variable. Like:

STACK_NAME=stag-example-com sh ./scripts/deploy.sh

To use and expand that environment variable inside thedocker-compose.yml files you can add the constraints to the services like:

version:'3'services:db:volumes:      -'app-db-data:/var/lib/postgresql/data/pgdata'deploy:placement:constraints:          -node.labels.${STACK_NAME?Variable not set}.app-db-data == true

note the${STACK_NAME?Variable not set}. In the script./scripts/deploy.sh, thedocker-compose.yml would be converted, and saved to a filedocker-stack.yml containing:

version:'3'services:db:volumes:      -'app-db-data:/var/lib/postgresql/data/pgdata'deploy:placement:constraints:          -node.labels.example-com.app-db-data == true

Note: The${STACK_NAME?Variable not set} means "use the environment variableSTACK_NAME, but if it is not set, show an errorVariable not set".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can usedocker-auto-labels to do it automatically.

You can usedocker-auto-labels to automatically read the placement constraint labels in your Docker stack (Docker Compose file) and assign them to a random Docker node in your Swarm mode cluster if those labels don't exist yet.

To do that, you can installdocker-auto-labels:

pip install docker-auto-labels

And then run it passing yourdocker-stack.yml file as a parameter:

docker-auto-labels docker-stack.yml

You can run that command every time you deploy, right before deploying, as it doesn't modify anything if the required labels already exist.

If you don't want to usedocker-auto-labels or for any reason you want to manually assign the constraint labels to specific nodes in your Docker Swarm mode cluster, you can do the following:

• First, connect via SSH to your Docker Swarm mode cluster.

• Then check the available nodes with:

$docker node ls// you would see an output like:ID                            HOSTNAME               STATUS              AVAILABILITY        MANAGER STATUSnfa3d4df2df34as2fd34230rm *   dog.example.com        Ready               Active              Reachable2c2sd2342asdfasd42342304e     cat.example.com        Ready               Active              Leaderc4sdf2342asdfasd4234234ii     snake.example.com      Ready               Active              Reachable

then chose a node from the list. For example,dog.example.com.

• Add the label to that node. Use as label the name of the stack you are deploying followed by a dot (.) followed by the named volume, and as value, justtrue, e.g.:

docker node update --label-add example-com.app-db-data=true dog.example.com

• Then you need to do the same for each stack version you have. For example, for staging you could do:

docker node update --label-add stag-example-com.app-db-data=true cat.example.com

There are 3 steps:

1. Build your app images
2. Optionally,push your custom images to a Docker Registry
3. Deploy your stack

Here are the steps in detail:

1. Build your app images

• Set these environment variables, right before the next command:
  • TAG=prod
  • FRONTEND_ENV=production
• Use the providedscripts/build.sh file with those environment variables:

TAG=prod FRONTEND_ENV=production bash ./scripts/build.sh

2. Optionally, push your images to a Docker Registry

Note: if the deployment Docker Swarm mode "cluster" has more than one server, you will have to push the images to a registry or build the images in each server, so that when each of the servers in your cluster tries to start the containers it can get the Docker images for them, pulling them from a Docker Registry or because it has them already built locally.

If you are using a registry and pushing your images, you can omit running the previous script and instead using this one, in a single shot.

• Set these environment variables:
  • TAG=prod
  • FRONTEND_ENV=production
• Use the providedscripts/build-push.sh file with those environment variables:

TAG=prod FRONTEND_ENV=production bash ./scripts/build-push.sh

3. Deploy your stack

• Set these environment variables:
  • DOMAIN=example.com
  • TRAEFIK_TAG=example.com
  • STACK_NAME=example-com
  • TAG=prod
• Use the providedscripts/deploy.sh file with those environment variables:

DOMAIN=example.com \TRAEFIK_TAG=example.com \STACK_NAME=example-com \TAG=prod \bash ./scripts/deploy.sh

If you change your mind and, for example, want to deploy everything to a different domain, you only have to change theDOMAIN environment variable in the previous commands. If you wanted to add a different version / environment of your stack, like "preproduction", you would only have to setTAG=preproduction in your command and update these other environment variables accordingly. And it would all work, that way you could have different environments and deployments of the same app in the same cluster.

Building and pushing is done with thedocker-compose.yml file, using thedocker-compose command. The filedocker-compose.yml uses the file.env with default environment variables. And the scripts set some additional environment variables as well.

The deployment requires usingdocker stack instead ofdocker-swarm, and it can't read environment variables or.env files. Because of that, thedeploy.sh script generates a filedocker-stack.yml with the configurations fromdocker-compose.yml and injecting the environment variables in it. And then uses it to deploy the stack.

You can do the process by hand based on those same scripts if you wanted. The general structure is like this:

# Use the environment variables passed to this script, as TAG and FRONTEND_ENV# And re-create those variables as environment variables for the next commandTAG=${TAG?Variable not set} \# Set the environment variable FRONTEND_ENV to the same value passed to this script with# a default value of "production" if nothing else was passedFRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \# The actual comand that does the work: docker-composedocker-compose \# Pass the file that should be used, setting explicitly docker-compose.yml avoids the# default of also using docker-compose.override.yml-f docker-compose.yml \# Use the docker-compose sub command named "config", it just uses the docker-compose.yml# file passed to it and prints their combined contents# Put those contents in a file "docker-stack.yml", with ">"config> docker-stack.yml# The previous only generated a docker-stack.yml file,# but didn't do anything with it yet# docker-auto-labels makes sure the labels used for constraints exist in the clusterdocker-auto-labels docker-stack.yml# Now this command uses that same file to deploy itdocker stack deploy -c docker-stack.yml --with-registry-auth"${STACK_NAME?Variable not set}"

If you use GitLab CI, the included.gitlab-ci.yml can automatically deploy it. You may need to update it according to your GitLab configurations.

If you use any other CI / CD provider, you can base your deployment from that.gitlab-ci.yml file, as all the actual script steps are performed inbash scripts that you can easily re-use.

GitLab CI is configured assuming 2 environments following GitLab flow:

• prod (production) from theproduction branch.
• stag (staging) from themaster branch.

If you need to add more environments, for example, you could imagine using a client-approvedpreprod branch, you can just copy the configurations in.gitlab-ci.yml forstag and rename the corresponding variables. The Docker Compose file and environment variables are configured to support as many environments as you need, so that you only need to modify.gitlab-ci.yml (or whichever CI system configuration you are using).

There is a maindocker-compose.yml file with all the configurations that apply to the whole stack, it is used automatically bydocker-compose.

And there's also adocker-compose.override.yml with overrides for development, for example to mount the source code as a volume. It is used automatically bydocker-compose to apply overrides on top ofdocker-compose.yml.

These Docker Compose files use the.env file containing configurations to be injected as environment variables in the containers.

They also use some additional configurations taken from environment variables set in the scripts before calling thedocker-compose command.

It is all designed to support several "stages", like development, building, testing, and deployment. Also, allowing the deployment to different environments like staging and production (and you can add more environments very easily).

They are designed to have the minimum repetition of code and configurations, so that if you need to change something, you have to change it in the minimum amount of places. That's why files use environment variables that get auto-expanded. That way, if for example, you want to use a different domain, you can call thedocker-compose command with a differentDOMAIN environment variable instead of having to change the domain in several places inside the Docker Compose files.

Also, if you want to have another deployment environment, saypreprod, you just have to change environment variables, but you can keep using the same Docker Compose files.

The.env file is the one that contains all your configurations, generated keys and passwords, etc.

Depending on your workflow, you could want to exclude it from Git, for example if your project is public. In that case, you would have to make sure to set up a way for your CI tools to obtain it while building or deploying your project.

One way to do it could be to add each environment variable to your CI/CD system, and updating thedocker-compose.yml file to read that specific env var instead of reading the.env file.

These are the URLs that will be used and generated by the project.

Production URLs, from the branchproduction.

Frontend:https://example.com

Backend:https://example.com/api/

Automatic Interactive Docs (Swagger UI):https://example.com/docs

Automatic Alternative Docs (ReDoc):https://example.com/redoc

PGAdmin:https://pgadmin.example.com

Flower:https://flower.example.com

Staging URLs, from the branchmaster.

Frontend:https://stag.example.com

Backend:https://stag.example.com/api/

Automatic Interactive Docs (Swagger UI):https://stag.example.com/docs

Automatic Alternative Docs (ReDoc):https://stag.example.com/redoc

PGAdmin:https://pgadmin.stag.example.com

Flower:https://flower.stag.example.com

Development URLs, for local development.

Frontend:http://localhost

Backend:http://localhost/api/

Automatic Interactive Docs (Swagger UI):https://localhost/docs

Automatic Alternative Docs (ReDoc):https://localhost/redoc

PGAdmin:http://localhost:5050

Flower:http://localhost:5555

Traefik UI:http://localhost:8090

Development URLs, for local development.

Frontend:http://local.dockertoolbox.tiangolo.com

Backend:http://local.dockertoolbox.tiangolo.com/api/

Automatic Interactive Docs (Swagger UI):https://local.dockertoolbox.tiangolo.com/docs

Automatic Alternative Docs (ReDoc):https://local.dockertoolbox.tiangolo.com/redoc

PGAdmin:http://local.dockertoolbox.tiangolo.com:5050

Flower:http://local.dockertoolbox.tiangolo.com:5555

Traefik UI:http://local.dockertoolbox.tiangolo.com:8090

Development URLs, for local development.

Frontend:http://dev.example.com

Backend:http://dev.example.com/api/

Automatic Interactive Docs (Swagger UI):https://dev.example.com/docs

Automatic Alternative Docs (ReDoc):https://dev.example.com/redoc

PGAdmin:http://dev.example.com:5050

Flower:http://dev.example.com:5555

Traefik UI:http://dev.example.com:8090

Development URLs, for local development.

Frontend:http://localhost.tiangolo.com

Backend:http://localhost.tiangolo.com/api/

Automatic Interactive Docs (Swagger UI):https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc):https://localhost.tiangolo.com/redoc

PGAdmin:http://localhost.tiangolo.com:5050

Flower:http://localhost.tiangolo.com:5555

Traefik UI:http://localhost.tiangolo.com:8090

This project was generated usinghttps://github.com/tiangolo/full-stack-fastapi-postgresql with:

pip install cookiecuttercookiecutter https://github.com/tiangolo/full-stack-fastapi-postgresql

You can check the variables used during generation in the filecookiecutter-config-file.yml.

You can generate the project again with the same configurations used the first time.

That would be useful if, for example, the project generator (tiangolo/full-stack-fastapi-postgresql) was updated and you wanted to integrate or review the changes.

You could generate a new project with the same configurations as this one in a parallel directory. And compare the differences between the two, without having to overwrite your current code but being able to use the same variables used for your current project.

To achieve that, the generated project includes the filecookiecutter-config-file.yml with the current variables used.

You can use that file while generating a new project to reuse all those variables.

For example, run:

$cookiecutter --config-file ./cookiecutter-config-file.yml --output-dir ../project-copy https://github.com/tiangolo/full-stack-fastapi-postgresql

That will use the filecookiecutter-config-file.yml in the current directory (in this project) to generate a new project inside a sibling directoryproject-copy.