GlobalWebIndex · nypen · Mar 28, 2025 · Mar 28, 2025 · Mar 28, 2025 · Mar 28, 2025
diff --git a/.env b/.env
@@ -0,0 +1 @@
+VITE_CAT_API_KEY='<YOUR_API_KEY>'
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.env
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,11 @@
+{
+	"semi": true,
+	"tabWidth": 4,
+	"printWidth": 100,
+	"singleQuote": true,
+	"trailingComma": "es5",
+	"jsxSingleQuote": true,
+	"bracketSpacing": true,
+	"useTabs": true,
+	"plugins": ["prettier-plugin-tailwindcss"]
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["bradlc.vscode-tailwindcss"]
+}
diff --git a/README.md b/README.md
@@ -19,3 +19,30 @@ We give you a lot of freedom in technologies and ways of doing things. We only i
 
 Once you have built your app, share your code in the mean suits you best
 Good luck, potential colleague!
+
+## Implementation
+
+### Tech Stack
+
+The project was built with `React`, `Typescript` and `Vite`.
+
+`Tailwind-css` and `DaisyUI` were used for styling.
+
+`axios` and `React Query` were used for interacting with the Cat API.
+
+No framework was used for state management as there was no need to maintain a state to cover the requirements.
+
+### Running the app
+
+To run the app:
+
+1. First [generate an API key](https://thecatapi.com/signup) for Cat API and add it in `.env` file.
+
+```
+VITE_CAT_API_KEY=myCatApiKey
+```
+
+2. Open a terminal and run `npm i`
+3. Run `npm run dev`
+
+The app is served at `http://localhost:5173/`
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)
diff --git a/index.html b/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Only Cats</title>
+		<link rel="icon" type="image/x-icon" href="/src/assets/paw_ico.ico" />
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>