template-fastapi-react: v1.5.0

1.5.0 (2024-07-22)

Features

• add auth (a201f13)
• add axios (88448c2)
• add equinor design system (b96d4da)
• add equinor typeface (53a7423)
• add eslint to pre-commit (20c872d)
• Add extra checks to pre-commit and run safety in venv (27a6cbe)
• add flake8, safety and pytests to pre-commit (1917997)
• Add info popover with version (28aa513), closes #154
• add mypy type checking to pre-commit (437cedd)
• add OpenCensusRequestLoggingMiddleware middleware (b9c035b)
• add Popover component (c8964bd)
• add prettier (b1ce63a)
• add react context to handle todo state (510e470)
• add reusable IconButton component (f933e30)
• allow each user to have their own todos (9456ab8)
• autogenerate release changelog (e463ae2)
• build and push images in ci (477ad85)
• create-react-app with typescript and equinor icons (2cfa523)
• expand and visualize auth states (51c9870)
• init todo example (8beaf08)
• official nginx image running unprivileged (fab0c14)
• pre-commit in CI from pre-commit-config.yaml (5d806b5)
• pre-commit: Add autoflake to pre-commits (8d97b34), closes #31
• replace exception handling (35ae0ef)
• replace prettier and eslint with biome (afe2cb9)
• response decorator takes Response type as parameter (9a7f228)
• reusable gh actions workflows (d557ebc)
• show changelog in documentation (6da9b86)
• standardized ErrorResponse model (c09e4dc)
• tutorial on authentication (fd789c0)
• web: clear input on add-todo (d61adc1)
• web: visualize loading state better (6a6ab81)

Bug Fixes

• add error handling of version file fetch (a4f6889)
• add missing decorators (54fd2f8)
• add missing dependency without causing infinite loop of rerendering (8f5c01d)
• add required additional dependecies to eslint pre-commit env (cca8509)
• add types to fixtures (0528e5b)
• add venv (d682b08)
• api: handle lists in create_response (333f7d4)
• api: make health-check return PlainTextResponse (12d5169)
• api: raise MissingPrivilegeException when relevant (0c55af3)
• api: raise MissingPrivilegeException when relevant (613cc42)
• api: remove empty default pydantic field in models (0424282)
• cast variable that cannot be undefined to boolean (372f781)
• delete non existing item should return 404 (4341416)
• dev: env_file in docker-compose.override.yml (PR #39) (2aa80bd)
• disable pull (de2d045)
• docs reference out of date (bd4cc8d)
• duplicated pre-commit hook (a21f5a6)
• extras typing is not always dict[str,str] (7ba0694)
• fix mypy errors (d9543c1)
• fix pytest_plugin import error (b521819)
• lock cryptography dependency since a bad new release. Set authentication scheme to allow for no tokens. Exclude some file from pre-commit (ea6a931)
• make authentication work again (3e8da0f)
• make todo title required, not optional (bc8dab6)
• make useTodos simpler to use (e8f0a18)
• move Response decorator to controllers (bd36b4a)
• only allow users to delete their own todos (1cf1e7a)
• only run safety hook once (bc33372)
• poetry command (ccbb2e1)
• pre-commit (5192d0e)
• python-version (a934109)
• ran api again (afa8158)
• ran generator (19ff51b)
• remove /api as root path. (208ceb9)
• remove encryption.py (a500444)
• replace deprecated output definition (c53b003)
• replace gunicorn with horizontal scaling (a8baa0f)
• resolve PR feedback (bd3debe)
• set correct base path for docs (0dda0b2)
• set correct type on todo local state (2a4020c)
• test suite (31da3f7)
• tests: fix up integration tests with per-user todos (b7cc0ca)
• The template no longer use the node image in production (f9b68d9)
• turn off eslint rules that are unnecessary or might conflict with prettier (d6beaf7)
• typo (fb557b8)
• update old references (5152a1f)
• update to match new parameters for get pydantic json schema (c6b14a8)
• use const on variable that is never reassigned (9f7c543)
• web: adding todo item now clears input. (82e6f6b)
• web: correct base path (a3872d5)
• yarn build again (dfc48fd)

Documentation

• Adapt config file (8b47298), closes #70
• add application tree (59aaf94)
• add configuration section to extending the API page (928e7f5)
• add data provider (e3f0055)
• add example to git commit format (9e7f1dc)
• add glossary of terms and explain enterprise vs application logic (edc720f)
• add how to extend the web (6700cbd)
• add how to tests components (ba78d28)
• add link to API docs (e5f8638)
• add link to demo (f1475f6)
• add missing environment variables descriptions (0b228fb)
• add on push to main branch badge (657f3b7)
• add overview (8287989)
• add what is fastapi (bbec23b)
• addd list of features (e8304a3)
• allow and move plantuml directly in markdown (99bacb4)
• ci: add comment to azure login (f6b9c96)
• Delete blog (85f43fd), closes #70
• Fix baseUrl bug (b14aa8c), closes #70
• fix broken links (de60d94)
• Fix broken links (6b18ff5), closes #70
• Fix frontpage (c304538), closes #70
• Generate docs on feature branch push (73fa918), closes #70
• how to contribute to template (526b4b0)
• how to register a feature to the app (efdba6b)
• minor change to clean architecture (ac0b607)
• Move and adapt markdown files (8dfc7d9), closes #70
• move contributing to own page (cc19714)
• move glossary of terms to end of page and explain the two business logic layers (02f9b70)
• Move images (ac1e323), closes #70
• overview of github workflows (839d1b5)
• overview of pre-commit hooks (e479932)
• re-structure documentation (4187823)
• re-write intro to controllers (cb1b28a)
• Readd puml files (290eb69), closes #70
• remove calculations from description (178829d)
• Remove comment (1626088), closes #70
• Remove docs build on feature push (4d41153), closes #70
• Remove error in documentation docs (5d1075f), closes #70
• remove key features (1e97ba8)
• Remove references to Doctave (6949799), closes #70
• remove simulations from API description (ac49fdd)
• Remove unused docusaurus files (13a6f92), closes #70
• remove web app image in introduction (0bf620d)
• rename of the application (e7c6952)
• Rename Tutorial to Docs (1c92b9e)
• Respect browser color scheme (63289ba), closes #70
• revert left to right for diagrams (6ab6ea7)
• rewrite 01-setup Yarn PnP in VSCode (df4c7d0)
• Run create-docusaurus (c52ff06), closes #70
• style feature list (568539e)
• turn puml diagrams sideways (a7a35fa)
• Update documentation version (76f1aaa), closes #70
• Update github workflow (e2eba4a), closes #70
• update link to radix playground (6c932c3)
• use tabs to show platform specific options (2216c0a)

Styles

• fix typos + add codespell pre-commit hook (025ad8a)
• Make eslint.js and index.js prettier (9d22357), closes #44
• run biome (27b2b15)

Miscellaneous Chores

• add action to initialize state fetched asynchronously (d85b789)
• add eslint for typescript (a6f8e7f)
• add issue templates and labels (32cadec)
• add labels to cover conventional commits (57dd018)
• add script to run eslint (2c8e006)
• add union type to support broader area of usage (f253241)
• add vitest (6c45021)
• Add yarn upgrade-interactive (91d998f)
• api: return Pydantic model instead of dict (427a963)
• build: add pre-commit hook to generate ts api (caec39e)
• build: delete old generated ts files (12c8766)
• build: generate new files, and use them (5c16ae9)
• build: install new api codegen tool (6318b37)
• bump web node image version (337ed61)
• configure prettier recommended plugin (40d8527)
• dev: add black formatter location to specify line length (2755265)
• dev: make CRA websocket use port 80 (53d2518)
• disable unnecessary rules after the new jsx transform from React 17 (9109e77)
• document bandit exception (b3a5460)
• fix file-formatter hooks exclude regex (61a3e36)
• fix yarn pnp runtime files (no-install setup) (1940186)
• forward ref to IconButton (02b1edd)
• generate api with axios (a2fea02)
• ignore correct path eslint (8c1a88e)
• ignore diffs on yarn plugins (78017e5)
• ignore generated folder on formatting/linting (8471ab1)
• init api and web (5602961)
• main: release 1.0.0 (b490f57)
• main: release 1.1.0 (0fc8052)
• main: release 1.1.1 (89d74cb)
• main: release 1.2.0 (48fe424)
• main: release 1.2.1 (0b2bcc3)
• main: release 1.3.0 (1d8d8bb)
• main: release 1.4.0 (0c37123)
• pre-commit: Change from autoflake to pycln (2104864), closes #31
• pre-commit: Make local tests run on windows (8171738)
• pre-commit: Move autoflake before isort (984f69e)
• prettier ignores files in node_modules by default (23da6e5)
• remove conditional render (36745ec)
• remove dead links to demo application (e6dd31d)
• remove empty catch (0264cb5)
• remove flake8 file from Dockerfile (fe48903)
• remove old yarn-2 stuff (ddbb339)
• remove package-lock (4ea4417)
• remove PnP (5263327)
• remove react-app from eslint extends (debatable) (1f955d6)
• remove redundant conditional (925d5b4)
• remove safety from dependencies (0e69345)
• remove safety from pre-commit (d0719fd)
• remove unused export (48199e7)
• replace deprecated pytest function (d35b0c3)
• set language version interrogate (57032e8)
• substitute HashRouter with BrowserRouter in web app (c2230d5)
• type CommitInfo (2179e13)
• typing errors (1ebe695)
• Update all web packages (a193af5)
• update dependencies (fb2cf50)
• update dependencies (67061eb)
• update gitignore (995ee82)
• update poetry.lock (ce07368)
• update sdks (385a55e)
• upgrade release-please (381ee02)
• upgrade versions (bc9f6a3)
• upgrade versions (041f78e)
• vscode: Stop git ignoring vscode settings (2b643d1), closes #44
• yarn: Stop running redundant yarn install (4841577), closes #44
• yarn: Use Yarn Zero-Install (ae03fa6), closes #44

Code Refactoring

• adding middleware and exception handlers recommended way (11384e9)
• all files under feaures (10df906)
• api: fix type errors in vscode (fd40ccb)
• api: replace response_class with return type annotations (b1fa3bd)
• change test URL to match root path (7c66513)
• ci: extract ghcr login into separat step (0d90fe0)
• ci: remove crazy-max external action (b41990d)
• configure prettier on src folder (14d63aa)
• conform to snake_case filenames (018918e)
• create empty yarn.lock (39050e7)
• improve type-strictness (961a7b2)
• memoize todoAPI, closes #199 (35059fa)
• migrate to pydantic v2 (7b0099b)
• mocking database using mongomock (19b7023)
• move default mongo client outside (9c241ff)
• move default react eslint config from package.json to .eslintrc (bbcf3b5)
• move dependency to API to useTodoAPI hook (4055f89)
• move todo component out from App.tsx (edfd9f6)
• remove empty catch (f4024bf)
• remove old repository mock (624cf0a)
• remove prefix in API url path (bc99f93)
• remove pyproject.toml parsing with extra-files (c1d812a)
• remove repeated code (DRY) (c5e6aa1)
• remove tool versions file (480e38e)
• remove unused className (1ee3eff)
• remove unused doctave file (c42fdeb)
• rename infrastructure to data_providers (8630fb7)
• rename list() member-function to list_collection (7ef87c0)
• rename popover state setter (500ec0a)
• rename unit tests from infrastructure to data providers (bbd21ba)
• render TodoApp.tsx as single component in App (f823831)
• replace python-jose with pyjwt (0d01e42)
• rework design (eds) (f3db74a)
• rewrite logger middleware to be a 'pure ASGI' middleware (309620e)
• separate responsibilities by moving useEffect to a custom hook (cc33a5d)
• structure web to group files by feature (cb5a09b)
• update some react/axios-related types (43e22fb)
• update typing to python 3.10+ syntax (245c699)
• use <Icon> data prop instead of name (5f142a9)
• use case responses decorator instead of use case executor (d0af7e4)
• use common toggle function (ab78e1f)
• use default URL for docs and openapi specification (8b11fed)
• use descriptive property name (80af660)
• use IconButton (c3d236a)
• use IconButton to reduce complexity of TodoItem (3bb232f)
• Use NginX as web server (3c6ebd9)
• use Popover component (270f2ea)
• use settings in pyproject.toml for pre commit hooks related to python (19c397f)
• use TodoContext to handle todos state (7d6cc34)
• use version from pyproject.toml in docs (015206c)
• workflow: Fix linting errors (8ea9f69)
• workflow: rename and restructure workflows (f08fffa)

Tests

• add jsx-a11y to check accessibility rules on jsx elements (77b865d)
• add rules of hooks (4d0d771)
• add some simple web tests (81fde9c)
• add unit and integration tests to exception handler (1d32e62)
• docs: Add testing of docs (08d8c23)
• mock authorization (618258c)
• move pytest configuration to pyproject.toml (a5eff87)
• Upgrade pre-commits (bd8f110)

Build System

• add mongodb to run in radix (43faa80)
• add path to init.sh to cmd (10feabb)
• add react-oauth2-code-pkce (06b2a27)
• add typescript plugin (83ade0c)
• adding missing packges (02a92ca)
• api crashes fix (e94a17e)
• api: add requests library (4c4790d)
• bump python version to 3.11 (225a530)
• bump versions in pyproject.toml (b185366)
• ci/cd: update flake8 repo location (e6953ad)
• deps: bump certifi from 2022.12.7 to 2023.7.22 in /api (a9ab785)
• deps: update react-oauth-code-pkce (37f6008)
• enable auth for web in readix (d8c6797)
• enable scripts to build necessary packages (YN0007) (f1cf2c3)
• fix mac m1 virtiofs docker problem (8c017a6)
• missing peer dependencies (YN0002) (9e8981d)
• move config of codespell to pyproject.toml (f3d4fa7)
• radix: add missing db environment variables for api (cc8ee59)
• radix: add missing port definition (fbf548e)
• radix: add missing root password for mongodb (71de476)
• radix: add more resources to api (f18518a)
• radix: non root mongodb image (a8a60f1)
• run as non-root (a5a255f)
• set oauth client id and audience (1fc42ec)
• set yarn version (afb5834)
• styled components post-install causing noise in yarn pnp (03dfac0)
• Update api packages (9dc46b4)
• update environment name (2c40003)
• update OAUTH_AUDIENCE settings (c38c8e2)
• web: replace cra and webpack with vite (4f67778)
• yarn: Migrate the lockfile (2e71fba), closes #44
• yarn: Set Yarn to version berry (e2a3352), closes #44
• yarn: Swithc to Plug'n'Play setup (751640e), closes #44
• yarn: Update Dockerfile (78bddad), closes #44
• yarn: Update gitignore (a527bec), closes #44
• yarn: Update yarn commands (5a0cbd2), closes #44

Continuous Integration

• activate publish (cc14523)
• add build and deploy settings for production (02dbc99)
• add check to typescript-client to ensure right api-spec is used (edc4621)
• Add rollback workflow (b1cca70), closes #153
• allow publishing multiple tags at once (4c5d867), closes #153
• api: enable ruff autofix (aeaac4d)
• api: enable upgradepy (59c75f7)
• api: replace flake8 with ruff (180a48c)
• bump pre-commit hooks (24455ca)
• bump pre-commit hooks (9a0cea7)
• call correct workflow file (cb2c2eb)
• change oauth redurect url to radix playground (655c55f)
• Change version logging format on build (49ca893), closes #154
• correct permissions (6d9d563)
• correct version path for web (781cef2)
• disable deploy workflows (7f3e275)
• enable publish latest (3716ee6)
• enforce conventional commits (c0a40b0)
• Fix bug in publish docs (a696a33)
• Include all commit types in changelog (73cfaaa)
• login as the service principal to request an access token (fabe3b4)
• pass tag name to publish-image workflow (dcedc16), closes #153
• pipeline not running (4b5e587)
• pre-commit: add end-of-file-fixer hook (cea07f1)
• pre-commit: add no-commit-to-branch hook (073879c)
• pre-commit: make convential commit hook run (d50f01d)
• pre-commit: update hook versions (a5bd7d3)
• publish nginx image to docker registry (939a29c)
• release to production on release created (b3e5e57)
• remove pycln (9614b7e)
• remove secret as input to reusable workflow (1ec6cbb)
• remove unused code (fda1325)
• replace local mypy with pre-commit hook (4cee89e)
• run pytest integrations tests (0fff7a3)
• set correct oauth redirect url for test environment (3c5db08)
• set correct radix environment to deploy for latest (aee20af)
• specify playground context (142bc13)
• update azure auth configuration (fb02376)
• use ruff implementation of isort and bandit (1151ec4)