Merge pull request #648 from Thenlie/develop

v1.10.0

Author: Thenlie

.eslintrc.json

@@ -48,6 +48,7 @@
         "react/react-in-jsx-scope": "off",
         "@typescript-eslint/no-unused-vars": "error",
         "prettier/prettier": "error",
-        "no-console": "error"
+        "no-console": "error",
+        "react/prop-types": "off"
     }
 }

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+## Description
+
+<!-- Provide a description of the changes made -->
+
+## Checklist
+
+<!-- Check off [x] once complete or if not applicable -->
+
+- [ ] Screenshots added for any UX changes
+- [ ] Demos attached for animations/interactions
+- [ ] Pointed at proper branch (`develop` not `main`)
+- [ ] Assigned PR to yourself
+- [ ] Requested review from code owners
+- [ ] Relevant labels added (`feature`, `documentation`, etc.)
+- [ ] `Closes #<issue-number>` added if this resolves a GitHub issue
+- [ ] Branch is up to date with develop, ran `git rebase develop` if necessary
+- [ ] All GitHub Actions are passing
+- [ ] `npm run todo-ci` ran if any todo comments were created

.storybook/main.ts

@@ -5,9 +5,9 @@ const config: StorybookConfig = {
     addons: [
         '@storybook/addon-links',
         '@storybook/addon-essentials',
-        '@storybook/addon-onboarding',
         '@storybook/addon-interactions',
         'storybook-addon-react-router-v6',
+        '@storybook/addon-themes',
     ],
     framework: {
         name: '@storybook/react-vite',

.storybook/preview.ts

@@ -1,4 +1,8 @@
 import type { Preview } from '@storybook/react';
+import { withThemeFromJSXProvider } from '@storybook/addon-themes';
+import { ThemeProvider } from '@mui/system';
+import { lightTheme, darkTheme } from '../src/theme';
+import { CssBaseline } from '@mui/material';
 import '../src/index.css'
 
 const preview: Preview = {
@@ -11,6 +15,17 @@ const preview: Preview = {
             },
         },
     },
+    decorators: [
+        withThemeFromJSXProvider({
+            themes: {
+              light: lightTheme,
+              dark: darkTheme,
+            },
+            defaultTheme: 'light',
+            Provider: ThemeProvider,
+            GlobalStyles: CssBaseline,
+        }),
+    ]
 };
 
 export default preview;

TODO.md

@@ -1,17 +1,20 @@
 ### TODOs
 | Filename | line # | TODO |
 |:------|:------:|:------|
+| [src/__tests__/routes.tsx](src/__tests__/routes.tsx#L22) | 22 | #427 Import routes from main.tsx instead of using this |
 | [src/components/Navigation.tsx](src/components/Navigation.tsx#L88) | 88 | Error handling if any |
 | [src/components/Navigation.tsx](src/components/Navigation.tsx#L93) | 93 | #162 Use MUI ThemeProvider |
 | [src/components/Navigation.tsx](src/components/Navigation.tsx#L242) | 242 | Add a transition when search is expanded or collapsed |
-| [src/screens/DiscoverScreen.tsx](src/screens/DiscoverScreen.tsx#L11) | 11 | #194 Make skeleton loading screen |
+| [src/screens/DiscoverScreen.tsx](src/screens/DiscoverScreen.tsx#L62) | 62 | #613 |
 | [src/screens/PageNotFoundScreen.tsx](src/screens/PageNotFoundScreen.tsx#L25) | 25 | Implement better error handling |
 | [src/screens/PageNotFoundScreen.tsx](src/screens/PageNotFoundScreen.tsx#L26) | 26 | Handle thrown responses with 'isRouteErrorResponse' |
 | [src/screens/ShowDetailsScreen.tsx](src/screens/ShowDetailsScreen.tsx#L155) | 155 | #438 Handle case when no details are ever returned |
-| [src/supabase/profiles.ts](src/supabase/profiles.ts#L239) | 239 | #587 Ensure country code is valid |
+| [src/supabase/profiles.ts](src/supabase/profiles.ts#L253) | 253 | #587 Ensure country code is valid |
 | [src/__tests__/components/component.test.tsx](src/__tests__/components/component.test.tsx#L8) | 8 | #427 Re-enable tests when UI stable |
 | [src/__tests__/screens/authScreen.test.tsx](src/__tests__/screens/authScreen.test.tsx#L9) | 9 | #427 Re-enable tests when UI stable |
 | [src/__tests__/screens/movieScreen.test.tsx](src/__tests__/screens/movieScreen.test.tsx#L31) | 31 | #427 Re-enable tests when UI stable |
 | [src/__tests__/screens/navigation.test.tsx](src/__tests__/screens/navigation.test.tsx#L10) | 10 | #427 Re-enable tests when UI stable |
-| [src/components/auth/LoginForm.tsx](src/components/auth/LoginForm.tsx#L82) | 82 | We could try to get the AuthApiError type and use 'cause' instead |
-| [src/__tests__/screens/assets/showData.ts](src/__tests__/screens/assets/showData.ts#L247) | 247 | Fill out rest of data, this does not have all details |
+| [src/screens/auth/LoginScreen.tsx](src/screens/auth/LoginScreen.tsx#L86) | 86 | We could try to get the AuthApiError type and use 'cause' instead |
+| [src/screens/dashboard/DashboardGalleryScreen.tsx](src/screens/dashboard/DashboardGalleryScreen.tsx#L26) | 26 | If profile does not return after a few seconds, |
+| [src/screens/dashboard/DashboardGalleryScreen.tsx](src/screens/dashboard/DashboardGalleryScreen.tsx#L57) | 57 | #610 Create empty state |
+| [src/__tests__/screens/assets/showData.ts](src/__tests__/screens/assets/showData.ts#L260) | 260 | Fill out rest of data, this does not have all details |

docs/usage.md

@@ -18,10 +18,15 @@ git clone <repository_url>
 ```s
 npm install
 ```
-6. Finally, you need to run the set up command:
+
+6. Next, you need to run the set up command:
 ```s
 npm run setup
 ```
+This will ensure the projects git hooks run during the pre-commit step.
+
+7. Finally, you will need to install [docker](https://www.docker.com/) one your machine. This is used to run the local Supabase server.
+
 This should be everything you need to move on to the usage instructions!
 
 ---
@@ -36,6 +41,12 @@ npm run dev
 ```
 This will build and run the application in watch mode automatically. This means as you work on the application, your browser will automatically update when you save the code.
 
+You will also need to run a local Supabase instance. To do this, use the command:
+```s
+npm run db-start
+```
+This will start the local Supabase development server. From there, you will need to copy the anon-key and api url to the .env file. If you would like to have this step done automatically, you can run `npm run db-start-env` instead.
+
 If you would like to see a deployed version of your work, push your branch to remote. Vercel will automatically deploy that branch in a test site. 
 
 ## Storybook
@@ -56,7 +67,9 @@ If you run into issues with an npm install, use the command:
 ```s
 npm run clean
 ```
-This will delete and reinstall all `node_modules`. If this does not work, you may also need to reset your npm cache using the command:
+This will delete and reinstall all `node_modules` as well as the npm cache.
+
+If you see the error `permission denied` when running one of the script files, use the command:
 ```s
-npm cache clean --force
+chmod +x ./scripts/file-name
 ```