2 add content to home page (#9)

jonasrenault · web-flow · commit 797f4e075254 · 2023-06-29T10:26:51.000+02:00
* Improve home page with descriptions

* Fix typing errors

* Add screenshots to README

* Update ss

* Add license and badges

* Small fix on README

* Use fetch instead of axios to access github api and not send user token

* Fix unused import
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-name: Build and deploy
+name: Build
 
 on:
   # Trigger the workflow on push to main branch
@@ -7,7 +7,7 @@ on:
       - main
 
   workflow_run:
-    workflows: ["Run tests and linting"]
+    workflows: ["Test"]
     branches: [main]
     types:
       - completed
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: Run tests and linting
+name: Test
 
 on:
   # Trigger the workflow on push or pull request,
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2023 Jonas Renault
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,9 +1,22 @@
 # Fastapi-React-Mongodb-Docker
 
-[![Tests](https://github.com/jonasrenault/fastapi-react-mongodb-docker/actions/workflows/test.yml/badge.svg)](https://github.com/jonasrenault/fastapi-react-mongodb-docker/actions/workflows/test.yml)
+![Tests](https://github.com/jonasrenault/fastapi-react-mongodb-docker/actions/workflows/test.yml/badge.svg)
+![Build](https://github.com/jonasrenault/fastapi-react-mongodb-docker/actions/workflows/build.yml/badge.svg)
+[![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)
+![python_version](https://img.shields.io/badge/Python-%3E=3.10-blue)
 
 This is a template application for a FARM stack. FARM stands for FastAPI, React, MongoDB.
 
+## Features
+
+### Clean design with minimal dependencies
+
+[![API docs](frontend/public/farmd-1.png)](https://github.com/jonasrenault/fastapi-react-mongodb-docker)
+
+### Basic user management with OAuth2 SSO
+
+[![API docs](frontend/public/farmd-2.png)](https://github.com/jonasrenault/fastapi-react-mongodb-docker)
+
 ## Project structure
 
 The project is composed of :
diff --git a/backend/poetry.lock b/backend/poetry.lock
diff --git a/frontend/public/beanie.svg b/frontend/public/beanie.svg
@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="19.109228mm"
+   height="20.085741mm"
+   viewBox="0 0 19.109228 20.085741"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
+   sodipodi:docname="logo_only.svg">
+  <defs
+     id="defs2">
+    <style
+       id="style3774"
+       type="text/css">
+   <![CDATA[
+    .fil1 {fill:#91000F}
+    .fil2 {fill:#FF0A0A}
+    .fil0 {fill:black;fill-rule:nonzero}
+   ]]>
+  </style>
+    <clipPath
+       clipPathUnits="userSpaceOnUse"
+       id="clipPath3845">
+      <rect
+         id="rect3847"
+         width="2099.4275"
+         height="2492.2449"
+         x="-1280.8276"
+         y="-681.63812"
+         style="stroke-width:26.14247894" />
+    </clipPath>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.7"
+     inkscape:cx="770.84798"
+     inkscape:cy="43.691031"
+     inkscape:document-units="mm"
+     inkscape:current-layer="Слой_x0020_1"
+     showgrid="false"
+     inkscape:window-width="1920"
+     inkscape:window-height="1035"
+     inkscape:window-x="0"
+     inkscape:window-y="45"
+     inkscape:window-maximized="0" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-13.430839,-83.835696)">
+    <g
+       style="clip-rule:evenodd;fill-rule:evenodd;image-rendering:optimizeQuality;shape-rendering:geometricPrecision;text-rendering:geometricPrecision"
+       id="Слой_x0020_1"
+       transform="matrix(0.01012082,0,0,0.01012082,42.020045,87.38569)">
+  <metadata
+   id="CorelCorpID_0Corel-Layer" />
+
+  <g
+   id="g3828"
+   clip-path="url(#clipPath3845)"
+   transform="translate(-1755.2808,177.3954)">
+  <g
+     transform="translate(-1069.5197,-528.15785)"
+     id="_1346890621664">
+   <path
+   id="path3779"
+   d="m 3019.17,1211.4 c 95.63,55.09 143.46,138.26 143.46,249.5 0,92.51 -32.74,168.41 -98.24,227.66 -65.49,59.25 -146.06,88.88 -241.69,88.88 H 2359.59 V 685.92 h 430.37 c 93.56,0 172.3,28.85 236.24,86.54 63.93,57.69 95.9,131.24 95.9,220.64 0,90.44 -34.31,163.21 -102.92,218.3 z M 2789.95,887.07 h -215.19 v 240.13 h 215.19 c 33.27,0 61.07,-11.43 83.42,-34.31 22.35,-22.86 33.52,-51.46 33.52,-85.76 0,-34.31 -10.92,-62.89 -32.74,-85.75 -21.83,-22.87 -49.9,-34.31 -84.2,-34.31 z m 32.74,689.21 c 36.38,0 66.53,-12.21 90.44,-36.65 23.91,-24.42 35.87,-55.35 35.87,-92.78 0,-36.38 -11.96,-66.79 -35.87,-91.22 -23.91,-24.42 -54.06,-36.65 -90.44,-36.65 h -247.93 v 257.29 h 247.93 z m 653.36,-106.04 c 27.02,97.72 100.32,146.58 219.86,146.58 76.92,0 135.14,-25.99 174.64,-77.97 l 162.17,93.56 c -76.93,111.24 -190.24,166.84 -339.93,166.84 -128.9,0 -232.33,-38.98 -310.3,-116.95 -77.97,-77.96 -116.95,-176.2 -116.95,-294.71 0,-117.46 38.47,-215.45 115.39,-293.93 76.93,-78.48 175.69,-117.73 296.27,-117.73 114.35,0 208.69,39.5 283.01,118.51 74.33,79.01 111.49,176.72 111.49,293.15 0,25.99 -2.6,53.54 -7.8,82.64 h -587.86 z m -3.12,-155.93 h 397.63 c -11.43,-53.02 -35.09,-92.52 -70.94,-118.51 -35.87,-25.99 -76.67,-38.98 -122.41,-38.98 -54.06,0 -98.76,13.77 -134.1,41.32 -35.34,27.55 -58.73,66.27 -70.17,116.17 z M 4798.35,997.76 h 201.15 v 779.66 h -201.15 v -92 c -60.29,75.88 -145.02,113.82 -254.17,113.82 -103.95,0 -193.1,-39.76 -267.42,-119.28 -74.33,-79.53 -111.49,-176.98 -111.49,-292.38 0,-115.39 37.16,-212.84 111.49,-292.37 74.32,-79.53 163.46,-119.29 267.42,-119.29 109.15,0 193.88,37.94 254.17,113.83 v -92.01 z m -371.12,548.1 c 40.54,41.06 92,61.6 154.37,61.6 62.37,0 114.08,-20.53 155.15,-61.6 41.06,-41.05 61.6,-93.82 61.6,-158.27 0,-64.45 -20.53,-117.2 -61.6,-158.27 -41.06,-41.06 -92.78,-61.6 -155.15,-61.6 -62.38,0 -113.83,20.53 -154.37,61.6 -40.54,41.06 -60.82,93.82 -60.82,158.27 0,64.45 20.28,117.21 60.82,158.27 z M 5615.42,975.94 c 85.24,0 155.67,28.58 211.29,85.76 55.61,57.17 83.42,136.17 83.42,237.02 v 478.71 h -201.15 v -453.76 c 0,-51.98 -14.04,-91.74 -42.1,-119.29 -28.07,-27.55 -65.5,-41.32 -112.27,-41.32 -51.98,0 -93.56,16.12 -124.74,48.34 -31.19,32.23 -46.78,80.57 -46.78,145.02 v 421.01 H 5181.94 V 997.77 h 201.15 v 87.32 c 48.86,-72.77 126.3,-109.15 232.34,-109.15 z m 566.02,-71.72 c -33.26,0 -62.11,-12.22 -86.53,-36.65 -24.43,-24.42 -36.65,-53.28 -36.65,-86.54 0,-33.27 12.21,-62.37 36.65,-87.32 24.42,-24.95 53.28,-37.43 86.53,-37.43 34.31,0 63.67,12.48 88.11,37.43 24.42,24.95 36.64,54.05 36.64,87.32 0,33.27 -12.21,62.12 -36.64,86.54 -24.43,24.42 -53.8,36.65 -88.11,36.65 z m -99.79,873.21 V 997.77 h 201.15 v 779.66 z m 555.11,-307.19 c 27.02,97.72 100.32,146.58 219.86,146.58 76.92,0 135.14,-25.99 174.64,-77.97 l 162.17,93.56 c -76.93,111.24 -190.24,166.84 -339.93,166.84 -128.9,0 -232.33,-38.98 -310.3,-116.95 -77.97,-77.96 -116.95,-176.2 -116.95,-294.71 0,-117.46 38.47,-215.45 115.39,-293.93 76.93,-78.48 175.69,-117.73 296.27,-117.73 114.35,0 208.69,39.5 283.01,118.51 74.33,79.01 111.49,176.72 111.49,293.15 0,25.99 -2.6,53.54 -7.8,82.64 h -587.86 z m -3.12,-155.93 h 397.63 c -11.43,-53.02 -35.09,-92.52 -70.94,-118.51 -35.87,-25.99 -76.67,-38.98 -122.41,-38.98 -54.06,0 -98.76,13.77 -134.1,41.32 -35.34,27.55 -58.73,66.27 -70.17,116.17 z"
+   class="fil0"
+   inkscape:connector-curvature="0"
+   style="fill:#000000;fill-rule:nonzero" />
+
+   <g
+   id="g3787">
+    <path
+   id="path3781"
+   d="m 111.03,1657.99 c 30.67,47.29 87.38,118.37 115.72,172.7 138.52,265.55 274.99,126.79 463.42,31.69 303.44,-153.16 674.58,-334.4 938.24,-401.3 328.84,-83.46 268.57,-244.73 213.65,-352.04 -49.94,-97.56 -48.11,-243.29 -189.34,-306.53 C 1620.76,517.54 1462.51,329.77 1273.1,282.9 1212.24,82.21 1075.81,-14.33 940.6,1.72 794.41,14.61 712.32,150.76 593.22,201.96 449.56,253.3 310.58,217.84 166.91,269.18 7.78,332.5 -27.6,469.98 19.02,605.66 c 31,90.2 64.96,173.68 111.23,243.03 -105.42,94.19 -143.18,293.12 -6.29,461.15 -129.81,110.24 -89.39,230.19 -12.91,348.14 z"
+   class="fil1"
+   inkscape:connector-curvature="0"
+   style="fill:#91000f" />
+
+    <path
+   id="path3783"
+   d="m 1520.04,785.66 c -455.19,-2.8 -799.87,176.07 -1186.38,389.27 -97.2,63.87 -279.3,-182.7 -29.19,-362.59 60.95,-43.83 146.08,-73.74 257.68,-111.76 -89.27,14.34 -178.53,28.65 -267.8,42.99 -117.13,14.62 -167.73,-234.75 -87.43,-323.26 70.42,-77.58 213.51,-100.02 313.94,-93.58 97.1,6.25 180.65,-23.6 245.95,-102.01 46.3,-55.56 84.29,-104.73 161.85,-112.15 125.66,-12.02 208.97,54.58 254.62,217.2 -81.97,35.55 -135.71,96.36 -170.29,145.25 72.89,-54.97 159.32,-98.04 214.81,-111.66 209.37,99.56 286.19,249.86 292.24,422.31 z"
+   class="fil2"
+   inkscape:connector-curvature="0"
+   style="fill:#ff0a0a" />
+
+    <path
+   id="path3785"
+   d="m 1521.58,885.23 c -106.29,13.71 -217.98,33.57 -331.97,60.84 85.18,22.45 150.12,97.56 155.44,190.28 6.61,115.31 -81.51,214.14 -196.82,220.75 -115.31,6.61 -214.14,-81.51 -220.75,-196.81 -3.5,-61.1 19.58,-117.57 59.22,-158.14 -244.97,77.2 -492.21,191.11 -712.52,354.06 -94.86,70.16 -118.94,123.95 -40.03,227.7 25.34,33.33 43.56,59.73 60.09,90.51 136.31,253.87 164.29,186.05 403.19,60.3 304.89,-160.49 599.4,-292.92 945.14,-381.61 114.5,-29.37 182,-95.97 121.7,-220.16 -23.05,-47.51 -38.17,-89.27 -65.59,-151.93 -42.61,-97.36 -68.06,-109.87 -177.11,-95.79 z"
+   class="fil2"
+   inkscape:connector-curvature="0"
+   style="fill:#ff0a0a" />
+
+   </g>
+
+  </g>
+</g>
+
+ </g>
+  </g>
+</svg>
diff --git a/frontend/public/farmd-1.png b/frontend/public/farmd-1.png
diff --git a/frontend/public/farmd-2.png b/frontend/public/farmd-2.png
diff --git a/frontend/public/fastapi-mark.svg b/frontend/public/fastapi-mark.svg
@@ -0,0 +1 @@
+<svg fill="none" height="2500" width="2500" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 154 154"><circle cx="77" cy="77" fill="#05998b" r="77"/><path d="M81.375 18.667l-38.75 70H77.5l-3.875 46.666 38.75-70H77.5z" fill="#fff"/></svg>
diff --git a/frontend/public/hook-forms.svg b/frontend/public/hook-forms.svg
@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="background-color:#ec5990" fill='#fff' viewBox="0 0 100 100">
+    <g transform="scale(0.8) translate(12.5, 10)">
+        <path d="M73.56,13.32H58.14a8.54,8.54,0,0,0-16.27,0H26.44a11,11,0,0,0-11,11V81.63a11,11,0,0,0,11,11H73.56a11,11,0,0,0,11-11V24.32A11,11,0,0,0,73.56,13.32Zm-30.92,2a1,1,0,0,0,1-.79,6.54,6.54,0,0,1,12.78,0,1,1,0,0,0,1,.79h5.38v6.55a3,3,0,0,1-3,3H40.25a3,3,0,0,1-3-3V15.32ZM82.56,81.63a9,9,0,0,1-9,9H26.44a9,9,0,0,1-9-9V24.32a9,9,0,0,1,9-9h8.81v6.55a5,5,0,0,0,5,5h19.5a5,5,0,0,0,5-5V15.32h8.81a9,9,0,0,1,9,9Z"></path>
+        <path style="transform:translateX(-25px)" d="M71.6,45.92H54a1,1,0,0,0,0,2H71.6a1,1,0,0,0,0-2Z"></path>
+        <path d="M71.6,45.92H54a1,1,0,0,0,0,2H71.6a1,1,0,0,0,0-2Z"></path>
+        <path style="transform:translateX(-25px)" d="M71.1,69.49H53.45a1,1,0,1,0,0,2H71.1a1,1,0,0,0,0-2Z"></path>
+        <path d="M71.1,69.49H53.45a1,1,0,1,0,0,2H71.1a1,1,0,0,0,0-2Z"></path>
+    </g>
+    <rect x="0" y="0" rx="12" ry="12" width="100" height="100" stroke='white' fill-opacity="0" stroke-width="10"/>
+</svg>
diff --git a/frontend/public/mui.svg b/frontend/public/mui.svg
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="36" height="32" viewBox="0 0 36 32" fill="none">
+    <path d="M30.343 21.976a1 1 0 00.502-.864l.018-5.787a1 1 0 01.502-.864l3.137-1.802a1 1 0 011.498.867v10.521a1 1 0 01-.502.867l-11.839 6.8a1 1 0 01-.994.001l-9.291-5.314a1 1 0 01-.504-.868v-5.305c0-.006.007-.01.013-.007.005.003.012 0 .012-.007v-.006c0-.004.002-.008.006-.01l7.652-4.396c.007-.004.004-.015-.004-.015a.008.008 0 01-.008-.008l.015-5.201a1 1 0 00-1.5-.87l-5.687 3.277a1 1 0 01-.998 0L6.666 9.7a1 1 0 00-1.499.866v9.4a1 1 0 01-1.496.869l-3.166-1.81a1 1 0 01-.504-.87l.028-16.43A1 1 0 011.527.86l10.845 6.229a1 1 0 00.996 0L24.21.86a1 1 0 011.498.868v16.434a1 1 0 01-.501.867l-5.678 3.27a1 1 0 00.004 1.735l3.132 1.783a1 1 0 00.993-.002l6.685-3.839zM31 7.234a1 1 0 001.514.857l3-1.8A1 1 0 0036 5.434V1.766A1 1 0 0034.486.91l-3 1.8a1 1 0 00-.486.857v3.668z" fill="#007FFF" />
+</svg>
diff --git a/frontend/public/react-router-mark.svg b/frontend/public/react-router-mark.svg
@@ -0,0 +1,6 @@
+<svg width="94" height="61" viewBox="0 0 94 61" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M72.7315 20.9357C70.0548 20.0941 68.6725 20.3778 65.8649 20.071C61.5246 19.5976 59.7954 17.9013 59.0619 13.5356C58.6514 11.0985 59.1361 7.53022 58.0881 5.32106C56.0839 1.10875 51.3943 -0.780439 46.6828 0.297843C42.7049 1.20956 39.3951 5.18518 39.2117 9.266C39.0021 13.9254 41.657 17.901 46.2156 19.273C48.3814 19.9261 50.6825 20.2548 52.9444 20.4214C57.0925 20.7238 57.4113 23.0297 58.5335 24.9277C59.2409 26.1243 59.9264 27.3034 59.9264 30.8714C59.9264 34.4394 59.2365 35.6185 58.5335 36.8151C57.4113 38.7087 56.0271 39.9491 51.879 40.2559C49.6171 40.4225 47.3116 40.7513 45.1502 41.4044C40.5916 42.7807 37.9367 46.7519 38.1463 51.4113C38.3297 55.4921 41.6395 59.4678 45.6174 60.3795C50.3289 61.4621 55.0185 59.5686 57.0227 55.3563C58.075 53.1471 58.6514 50.6443 59.0619 48.2072C59.7998 43.8414 61.5289 42.1451 65.8649 41.6717C68.6725 41.3649 71.5783 41.6717 74.2093 40.177C76.9895 38.1456 79.4734 35.0968 79.4734 30.8714C79.4734 26.6459 76.7967 22.2156 72.7315 20.9357Z" fill="#F44250"/>
+<path d="M28.1997 40.7739C22.7285 40.7739 18.2656 36.3027 18.2656 30.8213C18.2656 25.3399 22.7285 20.8687 28.1997 20.8687C33.6709 20.8687 38.1338 25.3399 38.1338 30.8213C38.1338 36.2983 33.6665 40.7739 28.1997 40.7739Z" fill="#121212"/>
+<path d="M9.899 61C4.43661 60.9868 -0.0130938 56.498 2.89511e-05 51.0122C0.0132099 45.5353 4.4936 41.0773 9.96914 41.0948C15.4359 41.108 19.8856 45.5968 19.8681 51.0825C19.8549 56.5551 15.3745 61.0131 9.899 61Z" fill="#121212"/>
+<path d="M83.7137 60.9998C78.2339 61.0304 73.7361 56.5901 73.7052 51.122C73.6747 45.632 78.1068 41.1258 83.5646 41.0949C89.0444 41.0643 93.5423 45.5046 93.5731 50.9727C93.6036 56.4583 89.1716 60.9689 83.7137 60.9998Z" fill="#121212"/>
+</svg>
diff --git a/frontend/src/routes/home.tsx b/frontend/src/routes/home.tsx

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Run tests and linting`
	`1`	`+name: Test`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`# Trigger the workflow on push or pull request,`