[INIT] init repo

bouvyd · Sep 20, 2024 · 0d7da07 · 0d7da07
commit 0d7da07
Show file tree

Hide file tree

Showing 28 changed files with 5,805 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,39 @@
+# Node Modules
+node_modules/
+
+# Build output
+dist/
+
+# Vite cache
+.vite/
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+pnpm-error.log*
+
+# Dependency directories
+jspm_packages/
+
+# IDE files
+.vscode/
+.idea/
+
+# Typescript specific
+*.tsbuildinfo
+
+# Tailwind config artifacts
+tailwind.config.js
+tailwind.config.cjs
+tailwind.config.ts
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Mac OS and Linux system files
+.DS_Store
+*.swp
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Damien Bouvy
+
+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
@@ -0,0 +1,86 @@
+# Employee Quest
+
+Employee Quest is a browser extension designed to help you get to know your colleagues at Odoo.
+The application is built using React, TypeScript, and Vite, and it leverages various modern web
+development tools and libraries.
+
+It's basically a side-project made by an idiot who has difficulties remembering who's who at the
+office.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Development](#development)
+- [Building](#building)
+- [License](#license)
+
+## Features
+
+- Interactive game to learn about colleagues
+- Integration with Odoo for fetching employee data
+- Score
+- Responsive design with Tailwind CSS
+
+## Installation
+
+To install the project dependencies, run:
+
+```bash
+npm install
+```
+
+## Usage
+
+To start the development server, run:
+
+```bash
+npm run dev
+```
+
+This will start the Vite development server.
+
+You then need to install the browser extension on your browser by dragging the `dist` folder
+in the Extension Management page of your browser (you may need to enable "Developer mode" first).
+
+## Development
+
+### Project Structure
+
+The main files and directories in this project are:
+
+- `src/`: Contains the source code of the application
+  - `api/`: API calls to Odoo and score storage
+  - `components/`: React components
+  - `interfaces/`: TypeScript interfaces
+  - `styles/`: CSS and Tailwind configuration
+- `public/`: Static assets
+- `dist/`: Build output
+- `vite.config.ts`: Vite configuration file
+- `tsconfig.json`: TypeScript configuration file
+
+### Key Files
+
+- `src/main.tsx`: Entry point of the React application
+- `src/App.tsx`: Main application component
+- `src/api/odoo.ts`: API calls to Odoo
+- `src/api/scoreStorage.ts`: Score storage functions
+- `src/components/employeeCard.tsx`: Employee card component
+
+## Building
+
+To build the project, run:
+
+```bash
+npm run build
+```
+
+This will create a production build in the `dist/` directory.
+
+You will then be able to install the extension by loading the `dist` folder as an Unpacked Extension
+in your browser.
+
+## License
+
+This project is licensed under the MIT License.
diff --git a/index.html b/index.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/icon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Employee Quest</title>
+    <link rel="stylesheet" href="/src/styles.css" />
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/manifest.json b/manifest.json
@@ -0,0 +1,23 @@
+{
+  "manifest_version": 3,
+  "name": "Emlpoyee Quest",
+  "version": "1.0.0",
+  "action": {
+    "default_popup": "index.html"
+  },
+  "description": "Employee Quest - Get to know your colleagues at Odoo!",
+  "author": "Damien Bouvy - [email protected]",
+  "host_permissions": [
+    "https://www.odoo.com/*"
+  ],
+  "permissions": [
+    "storage"
+  ],
+  "background": {},
+  "icons": {
+    "16": "16.png",
+    "32": "32.png",
+    "48": "48.png",
+    "128": "128.png"
+  }
+}