refactored all usage of postgresql to mongodb

Author: Jibola

CONTRIBUTING.md

@@ -8,12 +8,12 @@ After you clone the project, there are several scripts that can help during deve
 
 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:
+Call it from one level above the project directory. So, if the project is at `~/code/full-stack-fastapi-mongodb/`, call it from `~/code/`, like:
 
 ```console
 $ cd ~/code/
 
-$ bash ./full-stack-fastapi-postgresql/scripts/dev-fsfp.sh
+$ bash ./full-stack-fastapi-mongodb/scripts/dev-fsfp.sh
 ```
 
 It will generate a new project with all the defaults at `~/code/dev-fsfp/`.
@@ -34,12 +34,12 @@ 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:
+Call it from one level above the project directory. So, if the project is at `~/code/full-stack-fastapi-mongodb/`, call it from `~/code/`, like:
 
 ```console
 $ cd ~/code/
 
-$ bash ./full-stack-fastapi-postgresql/scripts/dev-fsfp-back.sh
+$ bash ./full-stack-fastapi-mongodb/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.
@@ -51,7 +51,7 @@ After using `./scripts/dev-fsfp-back.sh`, there will be a bunch of generated fil
 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/
+$ cd ~/code/full-stack-fastapi-mongodb/
 
 $ bash ./scripts/dev-fsfp-back.sh
 ```
@@ -63,7 +63,7 @@ Run the tests. It creates a project `testing-project` *inside* of the project ge
 Call it from the root of the project, e.g.:
 
 ```console
-$ cd ~/code/full-stack-fastapi-postgresql/
+$ cd ~/code/full-stack-fastapi-mongodb/
 
 $ bash ./scripts/test.sh
 ```

README.md

@@ -1,12 +1,11 @@
-# Full Stack FastAPI, PostgreSQL, Neo4j & Nuxt 3 Base Project Generator
+# Full Stack FastAPI, React, MongoDB (FARM) Base Project Generator
 
-[![Build Status](https://app.travis-ci.com/whythawk/full-stack-fastapi-postgresql.svg?branch=master)](https://app.travis-ci.com/whythawk/full-stack-fastapi-postgresql)
-
-Accelerate your next web development project with this FastAPI/Nuxt.js base project generator.
+Accelerate your next web development project with this FastAPI/React/MongoDB base project generator.
 
 This project is for developers looking to build and maintain full-feature progressive web applications using Python on the backend / Typescript on the frontend, and want the complex-but-routine aspects of auth 'n auth, and component and deployment configuration, taken care of, including interactive API documentation. 
 
-This is a comprehensively updated fork of [Sebastián Ramírez's](https://github.com/tiangolo) [Full Stack FastAPI and PostgreSQL Base Project Generator](https://github.com/tiangolo/full-stack-fastapi-postgresql). FastAPI is updated to version 0.99 (July 2023), SQLAlchemy to version 2.0 (July 2023), and the frontend to Nuxt 3.6 (July 2023).
+This is an **experimental** fork of [Sebastián Ramírez's](https://github.com/tiangolo) [Full Stack FastAPI and PostgreSQL Base Project Generator](https://github.com/tiangolo/full-stack-fastapi-postgresql) and [Whythawk's](https://github.com/whythawk) [Full Stack FastAPI and PostgreSQL Base Project Generator](https://github.com/whythawk/full-stack-fastapi-postgresql). FastAPI is updated to version 0.103.2, MongoDB Motor 3.4, Beanie ODM 1.23, and the frontend to React.
+
 
 - [Screenshots](#screenshots)
 - [Key features](#key-features)
@@ -45,30 +44,23 @@ This is a comprehensively updated fork of [Sebastián Ramírez's](https://github
 
 ## Key features
 
-This FastAPI, PostgreSQL, Neo4j & Nuxt 3 repo will generate a complete web application stack as a foundation for your project development.
+This FastAPI, React, MongoDB repo will generate a complete web application stack as a foundation for your project development.
 
 - **Docker Compose** integration and optimization for local development.
 - **Authentication** user management schemas, models, crud and apis already built, with OAuth2 JWT token support & default hashing. Offers _magic link_ authentication, with password fallback, with cookie management, including `access` and `refresh` tokens.
 - [**FastAPI**](https://github.com/tiangolo/fastapi) backend with [Inboard](https://inboard.bws.bio/) one-repo Docker images:
-  - **SQLAlchemy** version 2.0 support for models.
-  - **MJML** templates for common email transactions.
-  - **Metadata Schema** based on [Dublin Core](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-3) for inheritance.
+  - **MongoDB Motor** https://motor.readthedocs.io/en/stable/
+  - **MongoDB Beanie** for handling ODM creation https://beanie-odm.dev/
   - **Common CRUD** support via generic inheritance.
   - **Standards-based**: Based on (and fully compatible with) the open standards for APIs: [OpenAPI](https://github.com/OAI/OpenAPI-Specification) and [JSON Schema](http://json-schema.org/).
   - [**Many other features**]("https://fastapi.tiangolo.com/features/"): including automatic validation, serialization, interactive documentation, etc.
-- [**Nuxt/Vue 3**](https://nuxt.com/) frontend:
+- [**Nextjs/React**](https://nextjs.org/) frontend:
   - **Authorisation** via middleware for page access, including logged in or superuser.
-  - **Model blog** project, with [Nuxt Content](https://content.nuxtjs.org/) for writing Markdown pages.
   - **Form validation** with [Vee-Validate 4](https://vee-validate.logaretm.com/v4/).
-  - **State management** with [Pinia](https://pinia.vuejs.org/), and persistance with [Pinia PersistedState](https://prazdevs.github.io/pinia-plugin-persistedstate/).
+  - **State management** with [Redux](https://redux.js.org/)
   - **CSS and templates** with [TailwindCSS](https://tailwindcss.com/), [HeroIcons](https://heroicons.com/), and [HeadlessUI](https://headlessui.com/).
-  - **Internationalisation** with [@nuxt/i18n](https://nuxt.com/modules/i18n).
-  - **PWA support** with [Vite PWA plugin](https://vite-pwa-org.netlify.app/frameworks/nuxt.html).
-- **PostgreSQL** database.
-- **PGAdmin** for PostgreSQL database management.
 - **Celery** worker that can import and use models and code from the rest of the backend selectively.
 - **Flower** for Celery jobs monitoring.
-- **Neo4j** graph database, including integration into the FastAPI base project.
 - Load balancing between frontend and backend with **Traefik**, so you can have both under the same domain, separated by path, but served by different containers.
 - Traefik integration, including Let's Encrypt **HTTPS** certificates automatic generation.
 - GitLab **CI** (continuous integration), including frontend and backend testing.
@@ -85,14 +77,14 @@ This FastAPI, PostgreSQL, Neo4j & Nuxt 3 repo will generate a complete web appli
 
 After using this generator, your new project (the directory created) will contain an extensive `README.md` with instructions for development, deployment, etc. You can pre-read [the project `README.md` template here too](./{{cookiecutter.project_slug}}/README.md).
 
-This current release (August 2023) is for FastAPI version 0.99 and is the last before introducing support for Pydantic 2. Since this is intended as a base stack on which you will build complex applications, there is no intention of backwards compatability between releases, and the objective is to ensure that each release has the latest long-term-support versions of the core libraries so that you can rely on your application core for as long as possible.
+This current release (October 2023) is for FastAPI version 0.103 and introduces support for Pydantic 2. Since this is intended as a base stack on which you will build complex applications, there is no intention of backwards compatability between releases, and the objective is to ensure that each release has the latest long-term-support versions of the core libraries so that you can rely on your application core for as long as possible.
 
 To align with [Inboard](https://inboard.bws.bio/), Poetry has been deprecated in favour of [Hatch](https://hatch.pypa.io/latest/). This will also, hopefully, sort out some Poetry-related Docker build errors.
 
-You will also find an initial implementation of internationalisation using [@nuxt/i18n](https://nuxt.com/modules/i18n). This is - at this time - a release candidate, so please do update and check their documentation for any changes. The [Vite PWA plugin](https://vite-pwa-org.netlify.app/frameworks/nuxt.html) is also included, along with a Node CLI for generating all necessary app icons. You will see links and notes to this in the [nuxt.config.ts](./{{cookiecutter.project_slug}}/frontend/nuxt.config.ts) file.
-
 ## Help needed
 
+This stack is in an experimental state, so there is no guarantee for bugs or issues. Please open an issue ticket against this repository to make us aware of issues and we will do our best to respond to them in a timely manner. Please leave feedback on features that would be very beneficial for developers who often leverage mongodb in their FastAPI stack.
+
 The tests are broken and it would be great if someone could take that on. Other potential roadmap items:
 
 - Translation: docs are all in English and it would be great if those could be in other languages.
@@ -101,43 +93,18 @@ The tests are broken and it would be great if someone could take that on. Other
 
 ## Release Notes
 
-See notes and [releases](https://github.com/whythawk/full-stack-fastapi-postgresql/releases). 
-
-## 0.8.2
-
-Fixing [#39](https://github.com/whythawk/full-stack-fastapi-postgresql/issues/39), thanks to @a-vorobyoff:
-
-- Exposing port 24678 for Vite on frontend in development mode.
-- Ensuring Nuxt content on /api/_content doesn't interfere with backend /api/v routes.
-- Checking for password before hashing on user creation.
-- Updating generated README for Hatch (after Poetry deprecation).
-- Minor fixes.
-
-### 0.8.1
-
-- Minor updates to Docker scripts for `build`.
-
-### 0.8.0
+See notes: 
 
-- Updates to `frontend`, [#37](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/37) by @turukawa:
-  - `@nuxtjs/i18n` for internationalisation, along with language selection component.
-  - `@vite-pwa/nuxt` along with button components for install and refreshing the app and service workers, and a CLI icon generator.
-  - `@nuxtjs/robots` for simple control of `robots.txt` permissions from `nuxt.config.ts`.
+## 0.1.0
 
-### 0.7.4
-- Updates: Complete update of stack to latest long-term releases. [#35](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/35) by @turukawa, review by @br3ndonland
-  - `frontend`:
-    - Node 16 -> 18
-	- Nuxt 3.2 -> 3.6.5
-    - Latest Pinia requires changes in stores, where imports are not required (cause actual errors), and parameter declaration must happen in functions.
-  - `backend` and `celeryworker`:
-    - Python 3.9 -> 3.11
-    - FastAPI 0.88 -> 0.99 (Inboard 0.37 -> 0.51)
-    - Poetry -> Hatch
-    - Postgres 14 -> 15
-- Fixed: Updated token url in deps.py [#29](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/29) by @vusa
-- Docs: Reorganised documentation [#21](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/21) by @turukawa
+- Replaced Next/Vue.js frontend framework with entirely React/Redux
+- Replaced Backend native connection of PostgreSQL/SQLAlchemy with MongoDB Motor/Beanie ODM
+- Removed Neo4j plugin
+- Removed Alembic Usage
+- Introduced new cookiecutter environment variables `mongo_host`, `mongo_user`, `mongo_password`, and `mongo_database`
+- Introduced support for Pydantic 2
 
+[Historic changes from whythawk](https://github.com/whythawk/full-stack-fastapi-postgresql/releases)
 [Historic changes from original](https://github.com/tiangolo/full-stack-fastapi-postgresql#release-notes)
 
 ## License

cookiecutter.json

@@ -28,8 +28,6 @@
     "mongodb_password": "changethis",
     "mongodb_database": "changethis",
 
-    "neo4j_password": "changethis",
-
     "traefik_constraint_tag": "{{cookiecutter.domain_main}}",
     "traefik_constraint_tag_staging": "{{cookiecutter.domain_staging}}",
     "traefik_public_constraint_tag": "traefik-public",

docs/deployment-guide.md

@@ -42,8 +42,6 @@ These files will also need to be customised for production deployment. Make alte
 
 This guide uses [DigitalOcean Droplets](https://www.digitalocean.com/pricing/droplets), so customise as required. Deploy to the smallest (currently 500MiB memory, 1 vCPU and 10GiB SSD for $4/month). You can upgrade later when you know your resource requirements.
 
-> **WARNING**: if you're using `neo4j` then the `java` server alone will need 1Gb of memory, and you may need a 2Gb to 4Gb base droplet. Plan accordingly. If you decide not to use it, you will need to carefully remove it. That will require editing `docker-compose.yml` and the start-up sequence in the backend. Shouldn't be too challenging.
-
 Ensure you add your SSH encryption keys on launch so that your server can be secure from the beginning.
 
 Deploy on whatever server image your prefer, although the default would be Ubuntu 20.04 (22.04 is the latest). End-of-life for 20.04 is April 2030, and for 22.04 is April 2032. You have time. The underlying image isn't that critical, as you'll be using the Docker images at their current versions.
@@ -56,7 +54,7 @@ For reference:
 - [Link Namecheap domain to DigitalOcean](https://www.namecheap.com/support/knowledgebase/article.aspx/10375/2208/how-do-i-link-a-domain-to-my-digitalocean-account/)
 - [Manage DNS records at DigitalOcean](https://docs.digitalocean.com/products/networking/dns/how-to/manage-records/)
 
-Don't forget to create DNS A records for `flower`, `neo4j`, `traefik`, and `pgadmin`.
+Don't forget to create DNS A records for `flower`, `traefik`.
 
 Now you should be able to login to your server and begin deployment.
 
@@ -318,7 +316,5 @@ These are the URLs served in production (replace `example.com` with your own):
 - 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
-- Traefik: https://traefik.example.com
-- Neo4j: https://neo4j.example.com
+- Traefik: https://traefik.example.com

docs/development-guide.md

@@ -61,10 +61,10 @@ The input variables, with their default values (some auto generated) are:
 - `smtp_emails_from_email`: The email account to use as the sender in the notification emails, it could be something like `[email protected]`.
 - `smtp_emails_from_name`: The email account name to use as the sender in the notification emails, it could be something like `Symona Adaro`.
 - `smtp_emails_to_email`: The email account to use as the recipient for `contact us` emails, it could be something like `[email protected]`.
-- `postgres_password`: Postgres database password. Use the method above to generate it. (You could easily modify it to use MySQL, MariaDB, etc).
-- `pgadmin_default_user`: PGAdmin default user, to log-in to the PGAdmin interface.
-- `pgadmin_default_user_password`: PGAdmin default user password. Generate it with the method above.
-- `neo4j_password`: Neo4j database password. Use the method above to generate it.
+- `mongo_host`: MongoDB host cluster URI password
+- `mongo_user`: MongoDB User account to access the cluster
+- `mongodb_password`: MongoDB password for access to the cluster
+- `mongodb_database`: MongoDB database to have the application operate within
 - `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_public_constraint_tag`: The tag that should be used by stack services that should communicate with the public.