🔧 Simplify scripts and development (fastapi#155)

* 🔧 Update scripts and configs

* 🔧 Add shebang to script

* 🔥 Remove test and dev configs, pass inline

* ✨ Add local development dev-link set up

* 📝 Update generated docs with refactor

* 📝 Add Contributing guide

Author: tiangolo

.gitignore

@@ -2,3 +2,4 @@
 testing-project
 .mypy_cache
 poetry.lock
+dev-link/

.travis.yml

@@ -9,4 +9,4 @@ services:
   - docker
 
 script:
-- bash ./test.sh
+- bash ./scripts/test.sh

CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Here are some short guidelines to guide you if you want to contribute to the development of the Full Stack FastAPI PostgreSQL project generator itself.
+
+After you clone the project, there are several scripts that can help during development.
+
+* `./scripts/dev-fsfp.sh`:
+
+Generate a new default project `dev-fsfp`.
+
+Call it from one level above the project directory. So, if the project is at `~/code/full-stack-fastapi-postgresql/`, call it from `~/code/`, like:
+
+```console
+$ cd ~/code/
+
+$ bash ./full-stack-fastapi-postgresql/scripts/dev-fsfp.sh
+```
+
+It will generate a new project with all the defaults at `~/code/dev-fsfp/`.
+
+You can go to that directory with a full new project, edit files and test things, for example:
+
+```console
+$ cd ./dev-fsfp/
+
+$ docker-compose up -d
+```
+
+It is outside of the project generator directory to let you add Git to it and compare versions and changes.
+
+* `./scripts/dev-fsfp-back.sh`:
+
+Move the changes from a project `dev-fsfp` back to the project generator.
+
+You would call it after calling `./scripts/dev-fsfp.sh` and adding some modifications to `dev-fsfp`.
+
+Call it from one level above the project directory. So, if the project is at `~/code/full-stack-fastapi-postgresql/`, call it from `~/code/`, like:
+
+```console
+$ cd ~/code/
+
+$ bash ./full-stack-fastapi-postgresql/scripts/dev-fsfp-back.sh
+```
+
+That will also contain all the generated files with the generated variables, but it will let you compare the changes in `dev-fsfp` and the source in the project generator with git, and see what to commit.
+
+* `./scripts/discard-dev-files.sh`:
+
+After using `./scripts/dev-fsfp-back.sh`, there will be a bunch of generated files with the variables for the generated project that you don't want to commit, like `README.md` and `.gitlab-ci.yml`.
+
+To discard all those changes at once, run `discard-dev-files.sh` from the root of the project, e.g.:
+
+```console
+$ cd ~/code/full-stack-fastapi-postgresql/
+
+$ bash ./scripts/dev-fsfp-back.sh
+```
+
+* `./scripts/test.sh`:
+
+Run the tests. It creates a project `testing-project` *inside* of the project generator and runs its tests.
+
+Call it from the root of the project, e.g.:
+
+```console
+$ cd ~/code/full-stack-fastapi-postgresql/
+
+$ bash ./scripts/test.sh
+```
+
+* `./scripts/dev-link.sh`:
+
+Set up a local directory with links to the files for live development with the source files.
+
+This script generates a project `dev-link` *inside* the project generator, just to generate the `.env` and `./frontend/.env` files.
+
+Then it removes everything except those 2 files.
+
+Then it creates links for each of the source files, and adds those 2 files back.
+
+The end result is that you can go into the `dev-link` directory and develop locally with it as if it was a generated project, with all the variables set. But all the changes are actually done directly in the source files.
+
+This is probably a lot faster to iterate than using `./scripts/dev-fsfp.sh`. But it's tested only in Linux, it might not work in other systems.

README.md

@@ -117,12 +117,12 @@ The input variables, with their default values (some auto generated) are:
 * `pgadmin_default_user_password`: PGAdmin default user password. Generate it with the method above.
 
 * `traefik_constraint_tag`: The tag to be used by the internal Traefik load balancer (for example, to divide requests between backend and frontend) for production. Used to separate this stack from any other stack you might have. This should identify each stack in each environment (production, staging, etc).
-* `traefik_constraint_tag_staging`: The Traefik tag to be used while on staging. 
+* `traefik_constraint_tag_staging`: The Traefik tag to be used while on staging.
 * `traefik_public_constraint_tag`: The tag that should be used by stack services that should communicate with the public.
 
-* `flower_auth`: Basic HTTP authentication for flower, in the form`user:password`. By default: "`root:changethis`".
+* `flower_auth`: Basic HTTP authentication for flower, in the form`user:password`. By default: "`admin:changethis`".
 
-* `sentry_dsn`: Key URL (DSN) of Sentry, for live error reporting. If you are not using it yet, you should, is open source. E.g.: `https://1234abcd:[email protected]/30`.
+* `sentry_dsn`: Key URL (DSN) of Sentry, for live error reporting. You can use the open source version or a free account. E.g.: `https://1234abcd:[email protected]/30`.
 
 * `docker_image_prefix`: Prefix to use for Docker image names. If you are using GitLab Docker registry it would be based on your code repository. E.g.: `git.example.com/development-team/my-awesome-project/`.
 * `docker_image_backend`: Docker image name for the backend. By default, it will be based on your Docker image prefix, e.g.: `git.example.com/development-team/my-awesome-project/backend`. And depending on your environment, a different tag will be appended ( `prod`, `stag`, `branch` ). So, the final image names used will be like: `git.example.com/development-team/my-awesome-project/backend:prod`.
@@ -141,7 +141,7 @@ After using this generator, your new project (the directory created) will contai
 
 ## Sibling project generators
 
-* Based on Couchbase: [https://github.com/tiangolo/full-stack-fastapi-couchbase](https://github.com/tiangolo/full-stack-fastapi-couchbase).
+* Full Stack FastAPI Couchbase: [https://github.com/tiangolo/full-stack-fastapi-couchbase](https://github.com/tiangolo/full-stack-fastapi-couchbase).
 
 ## Release Notes
 

dev-fsfp-config.yml

@@ -5,6 +5,11 @@
 # Exit in case of error
 set -e
 
+if [ ! -d ./full-stack-fastapi-postgresql ] ; then
+    echo "Run this script from outside the project, to integrate a sibling dev-fsfp project with changes and review modifications"
+    exit 1
+fi
+
 if [ $(uname -s) = "Linux" ]; then
     echo "Remove __pycache__ files"
     sudo find ./dev-fsfp/ -type d -name __pycache__ -exec rm -r {} \+

dev-fsfp.sh

@@ -0,0 +1,13 @@
+#! /usr/bin/env bash
+
+# Exit in case of error
+set -e
+
+if [ ! -d ./full-stack-fastapi-postgresql ] ; then
+    echo "Run this script from outside the project, to generate a sibling dev-fsfp project with independent git"
+    exit 1
+fi
+
+rm -rf ./dev-fsfp
+
+cookiecutter --no-input -f ./full-stack-fastapi-postgresql project_name="Dev FSFP"

dev-fsfp-back.sh scripts/dev-fsfp-back.sh

@@ -0,0 +1,34 @@
+#! /usr/bin/env bash
+
+# Exit in case of error
+set -e
+
+# Run this from the root of the project to generate a dev-link project
+# It will contain a link to each of the files of the generator, except for
+# .env and frontend/.env, that will be the generated ones
+# This allows developing with a live stack while keeping the same source code
+# Without having to generate dev-fsfp and integrating back all the files
+
+rm -rf dev-link
+mkdir -p tmp-dev-link/frontend
+
+cookiecutter --no-input -f ./ project_name="Dev Link"
+
+mv ./dev-link/.env ./tmp-dev-link/
+mv ./dev-link/frontend/.env ./tmp-dev-link/frontend/
+
+rm -rf ./dev-link/
+mkdir -p ./dev-link/
+
+cd ./dev-link/
+
+for f in ../\{\{cookiecutter.project_slug\}\}/* ; do
+    ln -s "$f" ./
+done
+
+cd ..
+
+mv ./tmp-dev-link/.env ./dev-link/
+mv ./tmp-dev-link/frontend/.env ./dev-link/frontend/
+
+rm -rf ./tmp-dev-link

scripts/dev-fsfp.sh

@@ -1,11 +1,13 @@
+#! /usr/bin/env bash
+
+set -e
+
 rm -rf \{\{cookiecutter.project_slug\}\}/.git
 rm -rf \{\{cookiecutter.project_slug\}\}/backend/app/poetry.lock
 rm -rf \{\{cookiecutter.project_slug\}\}/frontend/node_modules
 rm -rf \{\{cookiecutter.project_slug\}\}/frontend/dist
 git checkout \{\{cookiecutter.project_slug\}\}/README.md
 git checkout \{\{cookiecutter.project_slug\}\}/.gitlab-ci.yml
 git checkout \{\{cookiecutter.project_slug\}\}/cookiecutter-config-file.yml
-git checkout \{\{cookiecutter.project_slug\}\}/docker-compose.deploy.networks.yml
 git checkout \{\{cookiecutter.project_slug\}\}/.env
 git checkout \{\{cookiecutter.project_slug\}\}/frontend/.env
-

scripts/dev-link.sh

@@ -3,9 +3,11 @@
 # Exit in case of error
 set -e
 
+# Run this from the root of the project
+
 rm -rf ./testing-project
 
-cookiecutter --config-file ./testing-config.yml --no-input -f ./
+cookiecutter --no-input -f ./ project_name="Testing Project"
 
 cd ./testing-project