Merge pull request #1 from cssgunc/mel-GEN-14-code-architecture-setup

Organized files and added basic components
2025-04-06 20:50:17 -04:00 · 2024-02-10 14:32:52 -05:00 · 2024-02-10 14:32:52 -05:00 · 172661cbc5
commit 172661cbc5
parent e51215cbff 280ca20306
25 changed files with 306 additions and 159 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,35 @@
-# compass
+# 🧭 Compass Center's Internal Resource Management App
+
+## 🛠 Technologies
+- Next.js
+- TailwindCSS
+- TypeScript
+- PostgreSQL
+
+## 📁 File Setup
+```
+\compass
+    \components // Components organized in folders related to specific pages
+    \pages // Store all pages here
+        \api // API routes
+    \public // Local assets (minimize usage)
+    \utils // Constants, Routes, Classes, Dummy Data
+    \styles // CSS files
+```
+
+## 🚀 To Start
+Follow these steps to set up your local environment:
+```
+\\ Clone this repository 
+git clone https://github.com/cssgunc/compass.git
+\\ Go into main folder
+cd compass
+\\ Install dependencies
+npm install
+\\ Run local environment
+npm run dev
+```
+
+## 💡 Dev Notes
+- For each task, create a branch in the format '[your name]-[ticket number]-[task description]'
+- Only commit your work to that branch and then make a git request to '/main'
--- a/compass/app/favicon.ico
+++ b/compass/app/favicon.ico
--- a/compass/app/globals.css
+++ b/compass/app/globals.css
@ -1,27 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-:root {
-  --foreground-rgb: 0, 0, 0;
-  --background-start-rgb: 214, 219, 220;
-  --background-end-rgb: 255, 255, 255;
-}
-
-@media (prefers-color-scheme: dark) {
-  :root {
-    --foreground-rgb: 255, 255, 255;
-    --background-start-rgb: 0, 0, 0;
-    --background-end-rgb: 0, 0, 0;
-  }
-}
-
-body {
-  color: rgb(var(--foreground-rgb));
-  background: linear-gradient(
-      to bottom,
-      transparent,
-      rgb(var(--background-end-rgb))
-    )
-    rgb(var(--background-start-rgb));
-}
--- a/compass/app/layout.tsx
+++ b/compass/app/layout.tsx
@ -1,22 +1,20 @@
-import type { Metadata } from 'next'
-import { Inter } from 'next/font/google'
-import './globals.css'
-
-const inter = Inter({ subsets: ['latin'] })
-
+import '../styles/globals.css';
+import { Metadata } from 'next'
+ 
 export const metadata: Metadata = {
-  title: 'Create Next App',
-  description: 'Generated by create next app',
+  title: 'Login',
 }

 export default function RootLayout({
+  // Layouts must accept a children prop.
+  // This will be populated with nested layouts or pages
  children,
 }: {
  children: React.ReactNode
 }) {
  return (
    <html lang="en">
-      <body className={inter.className}>{children}</body>
+      <body>{children}</body>
    </html>
  )
-}
+}
--- a/compass/app/page.tsx
+++ b/compass/app/page.tsx
@ -1,113 +1,41 @@
-import Image from 'next/image'
+// pages/index.tsx

-export default function Home() {
-  return (
-    <main className="flex min-h-screen flex-col items-center justify-between p-24">
-      <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
-        <p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto  lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
-          Get started by editing&nbsp;
-          <code className="font-mono font-bold">app/page.tsx</code>
-        </p>
-        <div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
-          <a
-            className="pointer-events-none flex place-items-center gap-2 p-8 lg:pointer-events-auto lg:p-0"
-            href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            By{' '}
-            <Image
-              src="/vercel.svg"
-              alt="Vercel Logo"
-              className="dark:invert"
-              width={100}
-              height={24}
-              priority
-            />
-          </a>
-        </div>
-      </div>
-
-      <div className="relative flex place-items-center before:absolute before:h-[300px] before:w-[480px] before:-translate-x-1/2 before:rounded-full before:bg-gradient-radial before:from-white before:to-transparent before:blur-2xl before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-[240px] after:translate-x-1/3 after:bg-gradient-conic after:from-sky-200 after:via-blue-200 after:blur-2xl after:content-[''] before:dark:bg-gradient-to-br before:dark:from-transparent before:dark:to-blue-700 before:dark:opacity-10 after:dark:from-sky-900 after:dark:via-[#0141ff] after:dark:opacity-40 before:lg:h-[360px] z-[-1]">
-        <Image
-          className="relative dark:drop-shadow-[0_0_0.3rem_#ffffff70] dark:invert"
-          src="/next.svg"
-          alt="Next.js Logo"
-          width={180}
-          height={37}
-          priority
-        />
-      </div>
-
-      <div className="mb-32 grid text-center lg:max-w-5xl lg:w-full lg:mb-0 lg:grid-cols-4 lg:text-left">
-        <a
-          href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Docs{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Find in-depth information about Next.js features and API.
-          </p>
-        </a>
-
-        <a
-          href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Learn{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Learn about Next.js in an interactive course with&nbsp;quizzes!
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Templates{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Explore the Next.js 13 playground.
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Deploy{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Instantly deploy your Next.js site to a shareable URL with Vercel.
-          </p>
-        </a>
-      </div>
-    </main>
-  )
+import Button from '@/components/Button';
+import Input from '@/components/Input'
+import InlineLink from '@/components/InlineLink';
+import Paper from '@/components/auth/Paper';
+import { Metadata } from 'next'
+ 
+export const metadata: Metadata = {
+  title: 'Login',
 }
+
+export default function Page()  {
+    return (
+        <>
+            <Paper>
+                <form className="mb-0 mt-6 mb-6 space-y-4 rounded-lg p-4 shadow-lg sm:p-6 lg:p-8 bg-white">
+                    <div className="mb-4">
+                        <Input type='email' title="Email" placeholder="janedoe@gmail.com" />
+                    </div>
+                    <div className="mb-6">
+                        <Input type='password' title="Password" />
+                    </div>
+                    <div className="flex flex-col items-left space-y-4">
+                        <InlineLink>
+                            Forgot password?
+                        </InlineLink>
+                        <Button>
+                            Login
+                        </Button>
+
+                    </div>
+                </form>
+                <p className="text-center mt-6 text-gray-500 text-xs">
+                    &copy; 2024 Compass Center
+                </p>
+            </Paper>
+        </>
+    );
+};
+
--- a/compass/components/Button.tsx
+++ b/compass/components/Button.tsx
@ -0,0 +1,23 @@
+import { FunctionComponent, ReactNode } from 'react';
+
+type ButtonProps = {
+    children: ReactNode;
+    onClick?: () => void; // make the onClick handler optional
+};
+
+const Button: FunctionComponent<ButtonProps> = ({ children, onClick }) => {
+    return (
+        <button
+        // className="px-4 py-2 font-bold text-white bg-purple-600 rounded hover:bg-purple-700 focus:outline-none focus:ring-2 focus:ring-opacity-var focus:ring-color-var"
+        className="inline-block rounded border border-purple-600 bg-purple-600 px-12 py-3 text-sm font-semibold text-white hover:bg-transparent hover:text-purple-600 focus:outline-none focus:ring active:text-purple-500"
+        onClick={onClick}
+        // style={{
+        //   '--ring-opacity-var': `var(--ring-opacity)`,
+        //   '--ring-color-var': `rgba(var(--ring-color), var(--ring-opacity))`
+        // }}
+        >
+            {children}
+        </button>
+    );
+};
+export default Button;
--- a/compass/components/InlineLink.tsx
+++ b/compass/components/InlineLink.tsx
@ -0,0 +1,16 @@
+import React, { ReactNode } from 'react';
+
+interface Link {
+  href?: string;
+  children: ReactNode;
+}
+
+const InlineLink: React.FC<Link> = ({href = '#', children}) => {
+    return (
+        <a href={href} className='text-sm text-purple-600 hover:underline font-semibold italic'>
+            {children}
+        </a>
+    )
+}
+
+export default InlineLink;
--- a/compass/components/Input.tsx
+++ b/compass/components/Input.tsx
@ -0,0 +1,30 @@
+import React, { FunctionComponent, InputHTMLAttributes, ReactNode } from 'react';
+
+type InputProps = InputHTMLAttributes<HTMLInputElement> & {
+  icon?: ReactNode;
+  title?: ReactNode;
+  title?:ReactNode;
+  placeholder?:ReactNode
+};
+
+const Input: FunctionComponent<InputProps> = ({ icon, type, title, placeholder, ...rest }) => {
+  return (
+    <div>
+      <label
+  htmlFor={title}
+  className="block overflow-hidden rounded-md border border-gray-200 px-3 py-2 shadow-sm focus-within:border-purple-600 focus-within:ring-1 focus-within:ring-purple-600"
+>
+  <span className="text-xs font-semibold text-gray-700"> {title} </span>
+
+  <input
+    type={type}
+    id={title}
+    placeholder={placeholder}
+    className="mt-1 w-full border-none p-0 focus:border-transparent focus:outline-none focus:ring-0 sm:text-sm"
+  />
+</label>
+</div>
+  );
+};
+
+export default Input;
--- a/compass/components/auth/Paper.tsx
+++ b/compass/components/auth/Paper.tsx
@ -0,0 +1,15 @@
+import React, { ReactNode } from 'react';
+
+interface PageInterface {
+    children: ReactNode;
+}
+
+const Paper: React.FC<PageInterface> = ({ children }) => {
+    return (
+        <div className="w-full min-h-screen px-4 py-16 bg-gray-100 sm:px-6 lg:px-8">
+            {children}
+        </div>
+    );
+};
+
+export default Paper;
--- a/compass/package-lock.json
+++ b/compass/package-lock.json
@ -8,6 +8,7 @@
      "name": "compass",
      "version": "0.1.0",
      "dependencies": {
+        "@heroicons/react": "^2.1.1",
        "next": "13.5.6",
        "react": "^18",
        "react-dom": "^18"
@ -113,6 +114,14 @@
        "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
      }
    },
+    "node_modules/@heroicons/react": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/@heroicons/react/-/react-2.1.1.tgz",
+      "integrity": "sha512-JyyN9Lo66kirbCMuMMRPtJxtKJoIsXKS569ebHGGRKbl8s4CtUfLnyKJxteA+vIKySocO4s1SkTkGS4xtG/yEA==",
+      "peerDependencies": {
+        "react": ">= 16"
+      }
+    },
    "node_modules/@humanwhocodes/config-array": {
      "version": "0.11.13",
      "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.13.tgz",
--- a/compass/package.json
+++ b/compass/package.json
@ -9,19 +9,20 @@
    "lint": "next lint"
  },
  "dependencies": {
+    "@heroicons/react": "^2.1.1",
+    "next": "13.5.6",
    "react": "^18",
-    "react-dom": "^18",
-    "next": "13.5.6"
+    "react-dom": "^18"
  },
  "devDependencies": {
-    "typescript": "^5",
    "@types/node": "^20",
    "@types/react": "^18",
    "@types/react-dom": "^18",
    "autoprefixer": "^10",
+    "eslint": "^8",
+    "eslint-config-next": "13.5.6",
    "postcss": "^8",
    "tailwindcss": "^3",
-    "eslint": "^8",
-    "eslint-config-next": "13.5.6"
+    "typescript": "^5"
  }
 }
--- a/compass/public/fonts/Inter-Black.ttf
+++ b/compass/public/fonts/Inter-Black.ttf
--- a/compass/public/fonts/Inter-Bold.ttf
+++ b/compass/public/fonts/Inter-Bold.ttf
--- a/compass/public/fonts/Inter-ExtraBold.ttf
+++ b/compass/public/fonts/Inter-ExtraBold.ttf
--- a/compass/public/fonts/Inter-ExtraLight.ttf
+++ b/compass/public/fonts/Inter-ExtraLight.ttf
--- a/compass/public/fonts/Inter-Light.ttf
+++ b/compass/public/fonts/Inter-Light.ttf
--- a/compass/public/fonts/Inter-Medium.ttf
+++ b/compass/public/fonts/Inter-Medium.ttf
--- a/compass/public/fonts/Inter-Regular.ttf
+++ b/compass/public/fonts/Inter-Regular.ttf
--- a/compass/public/fonts/Inter-SemiBold.ttf
+++ b/compass/public/fonts/Inter-SemiBold.ttf
--- a/compass/public/fonts/Inter-Thin.ttf
+++ b/compass/public/fonts/Inter-Thin.ttf
--- a/compass/styles/globals.css
+++ b/compass/styles/globals.css
@ -0,0 +1,47 @@
+/* globals.css */
+@import 'tailwindcss/base';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';
+
+
+:root {
+    /* Colors */
+    --ring-color: 199, 21, 133;
+    /* This is the RGB value for a purple color */
+    --ring-opacity: 0.5;
+
+    /* Shadows */
+    --shadow-default: 0 1px 3px 0 rgba(0, 0, 0, 0.1), 0 1px 2px 0 rgba(0, 0, 0, 0.06);
+    --shadow-focus: 0 0 0 3px rgba(66, 153, 225, 0.5);
+
+    /* Borders */
+    --border-radius: 0.375rem;
+    /* 6px */
+    --border-width: 1px;
+
+    /* Spacing */
+    --spacing-px: 1px;
+    --spacing-2: 0.5rem;
+    /* 8px */
+    --spacing-3: 0.75rem;
+    /* 12px */
+
+    /* Font */
+    --font-color: #4a5568;
+    /* A shade of gray */
+}
+
+
+@font-face {
+    font-family: 'Inter';
+    font-style: normal;
+    font-weight: 400;
+    src: url('/fonts/Inter-Regular.ttf') format('ttf'),
+    url('/fonts/Inter-Bold.ttf') format('ttf'),
+    url('/fonts/Inter-Black.ttf') format('ttf'),
+    url('/fonts/Inter-ExtraBold.ttf') format('ttf'),
+    url('/fonts/Inter-ExtraLight.ttf') format('ttf'),
+    url('/fonts/Inter-Medium.ttf') format('ttf'),
+    url('/fonts/Inter-SemiBold.ttf') format('ttf'),
+    url('/fonts/Inter-Thin.ttf') format('ttf');
+  }
--- a/compass/tailwind.config.ts
+++ b/compass/tailwind.config.ts
@ -1,4 +1,4 @@
-import type { Config } from 'tailwindcss'
+import type { Config } from 'tailwindcss';

 const config: Config = {
  content: [
@ -10,11 +10,14 @@ const config: Config = {
    extend: {
      backgroundImage: {
        'gradient-radial': 'radial-gradient(var(--tw-gradient-stops))',
-        'gradient-conic':
-          'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
+        'gradient-conic': 'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
+      },
+      fontFamily: {
+        sans: ['Inter', 'sans-serif'],
      },
    },
  },
  plugins: [],
-}
-export default config
+};
+
+export default config;
--- a/compass/utils/classes/CollectionImpl.tsx
+++ b/compass/utils/classes/CollectionImpl.tsx
@ -0,0 +1,16 @@
+class CollectionImpl {
+    title: string;
+    icon: any;
+    data: any;
+
+    constructor(title: string, icon: any) {
+        this.title = title;
+        this.icon = icon;
+    }
+
+    // subject to change
+    setData(data: any){
+        this.data = data;
+    }
+
+}
--- a/compass/utils/constants.tsx
+++ b/compass/utils/constants.tsx
@ -0,0 +1,54 @@
+import { ListBulletIcon, HashtagIcon, Bars3BottomLeftIcon, EnvelopeIcon, AtSymbolIcon, ClipboardIcon, ArrowsUpDownIcon, ChevronDoubleRightIcon, ChevronDoubleLeftIcon, ChevronRightIcon, ChevronLeftIcon, EyeIcon, EyeSlashIcon, UserIcon, BookOpenIcon, MagnifyingGlassIcon, LinkIcon } from '@heroicons/react/24/solid';
+
+export const Icons = {
+  EmailInputIcon: EnvelopeIcon,
+  HidePasswordIcon: EyeSlashIcon,
+  UnhidePasswordIcon: EyeIcon,
+  UserIcon: UserIcon,
+  ResourceIcon: BookOpenIcon,
+  SearchIcon: MagnifyingGlassIcon,
+  ServiceIcon: ClipboardIcon,
+  CloseRightArrow: ChevronDoubleRightIcon,
+  CloseLeftArrow: ChevronDoubleLeftIcon,
+  LinkRightArrow:ChevronRightIcon,
+  LinkLeftArrow:ChevronLeftIcon,
+  SortIcon: ArrowsUpDownIcon,
+  EmailTableIcon:AtSymbolIcon,    
+  LinkTableIcon: LinkIcon,
+  TextTableIcon: Bars3BottomLeftIcon,
+  NumberTableIcon: HashtagIcon,
+  MultiselectTableIcon: ListBulletIcon
+};
+
+export enum User {
+    ADMIN,
+    EMPLOYEE,
+    VOLUNTEER
+}
+
+export enum COLLECTION {
+    RESOURCE,
+    SERVICE,
+    USER
+}
+
+export enum PROGRAM {
+    DOMESTIC_VIOLENCE,
+    ECONOMIC_STABILITY,
+    COMMUNITY_EDUCATION
+}
+
+export enum DATATYPE {
+    INTEGER,
+    STRING,
+    LINK,
+    EMAIL,
+    MULTISELECT,
+    SELECT
+}
+
+export const COLLECTION_MAP: {[key in COLLECTION]: CollectionImpl} = {
+    [COLLECTION.RESOURCE]: new CollectionImpl('Resources', Icons.ResourceIcon),
+    [COLLECTION.SERVICE]: new CollectionImpl('Services', Icons.ServiceIcon),
+    [COLLECTION.USER]: new CollectionImpl('Users', Icons.UserIcon)
+}
--- a/compass/utils/routes.tsx
+++ b/compass/utils/routes.tsx