Cleanup (#38)

* Restructure project and enhance overall clarity
  - Updated and cleaned up README.md for improved structure and clarity
  - Updated project for MySQL database compatibility
  - Fixed various TypeScript errors in index.tsx
  - Removed unused dependencies and redundant comments
  - Cleaned up migrations and codebase

* Added utilities and improved layout
  - Introduced clsx utility for conditional class names
  - Updated layout for better user experience

* Fixed paths and Docker-related configurations
  - Updated path to Docker file
  - Added .DS_Store to .gitignore

* General improvements
  - Updated project title for consistency
  - Updated build process for better performance

Author: devnoot

.github/workflows/build.yml

@@ -13,11 +13,13 @@ jobs:
       - uses: actions/checkout@v4
       - name: Build the Docker image
         run: |
+          cd webapp && \
           docker compose build \
             --no-cache \
-            --build-arg NODE_ENV="development" \
-            --build-arg DATABASE_URL=${{ secrets.DATABASE_URL }} \
-            --build-arg POSTGRES_PASSWORD=${{ secrets.POSTGRES_PASSWORD }} \
+            --build-arg NODE_ENV="production" \
+            --build-arg DB_URL=${{ secrets.DB_URL }} \
+            --build-arg DB_PASS=${{ secrets.DB_PASS }} \
+            --build-arg DB_NAME=${{ secrets.DB_NAME }} \
             --build-arg NEXTAUTH_URL=${{ secrets.NEXTAUTH_URL }} \
             --build-arg NEXTAUTH_SECRET=${{ secrets.NEXTAUTH_SECRET }} \
             --build-arg GOOGLE_CLIENT_ID=${{ secrets.GOOGLE_CLIENT_ID }} \

.gitignore

@@ -1,42 +1,4 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# database
-/prisma/db.sqlite
-/prisma/db.sqlite-journal
-
-# next.js
-/.next/
-/out/
-next-env.d.ts
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.pnpm-debug.log*
-
-# local env files
-# do not commit any .env files to git, except for the .env.example file. https://create.t3.gg/en/usage/env-variables#using-environment-variables
-.env
-.env*.local
-
-# vercel
-.vercel
-
-# typescript
-*.tsbuildinfo
+webapp/node_modules
+webapp/.next
+.github/.DS_Store
+.gitignore

README.md

@@ -1,65 +1,76 @@
-# Swarthmore A11yGator
+# Accessible Docs
 
-### **Welcome**  
-Swarthmore A11yGator is an innovative platform aimed at enhancing the accessibility of course materials for Swarthmore College students. This platform ensures an inclusive learning environment by providing remediated and accessible documents, notes, and other course materials to meet the diverse needs of students.
+## Welcome
+
+**Accessible Docs** is an innovative platform aimed at enhancing the accessibility of course materials for Swarthmore College students. This platform ensures an inclusive learning environment by providing remediated and accessible documents, notes, and other course materials to meet the diverse needs of students.
+
+## What's in this Repo?
+
+The **Accessible Docs** app is in the [webapp](webapp/) folder.
+The scripts folder contains [Python scripts](scripts/) used to prepare the data for the webapp.
+
+## Project Goals
+
+**Accessible Docs** aims to:  
+
+- Provide a central hub for students to access accessible course materials.  
+- Ensure compliance with accessibility standards such as WCAG.  
+- Continuously improve functionality and user experience based on user feedback.
+
+## Features
 
-### **Features**  
 - **Accessible Course Materials:** Access a variety of course documents, all remediated to comply with accessibility standards.  
 - **Light and Dark Mode:** Enjoy a user-friendly interface with customizable viewing preferences.  
 - **Responsive Design:** Seamlessly access materials on any device, from mobile phones to desktops.  
 - **AI-Powered Search:** Quickly find what you need using advanced AI-driven search functionality. *(Upcoming feature)*  
 - **Profile Customization:** Highlight and save readings, and personalize your material library. *(Upcoming feature)*
 
----
-
-### **Tech Stack**  
-- **Frontend:**  
-  - Next.js for server-side rendering.  
-  - React for dynamic client-side functionality.  
-- **Backend:**  
-  - tRPC for type-safe API routes without schema duplication.  
-  - Prisma ORM for seamless database interaction.  
-- **Database:** PostgreSQL for reliable and efficient data storage.  
-- **Authentication:** NextAuth.js for secure and simple user authentication.  
-- **Styling:** Tailwind CSS for a clean, responsive, and accessible design.  
-- **Hosting:** Vercel for continuous integration and deployment.  
-- **Storage:** AWS S3 for document storage and management.
+## For Developers
 
----
+### Quick Start
 
-### **Quick Start**  
 1. **Clone the Repository**  
+
    ```bash
-   git clone https://github.com/Swarthmore/a11y-doc-repo.git
-   cd a11y-doc-repo
+   git clone https://github.com/Swarthmore/accessible-docs.git
+   cd accessible-docs 
    ```
+
 2. **Install Dependencies**  
+
    ```bash
    npm install
    ```
+
 3. **Set Up Environment Variables**  
+
    - Copy the `.env.example` file to `.env` and populate it with the required values.  
    - Ensure you include your Google OAuth redirect URL in your Google Console dashboard.
+
 4. **Run Database Migration**  
+
    ```bash
-   npx prisma migrate resolve --applied 20240816170427_init
-   ```
-5. **Run in Docker** (Optional)  
-   Start the app in a Docker container:  
-   ```bash
-   docker compose up -d
+   npx prisma migrate deploy 
    ```
-6. **Start the Development Server**  
+
+5. **Start the Development Server**  
+
    ```bash
    npm run dev
    ```
 
----
+You can also run the project in docker using `docker-compose up`
 
-### **Project Goals**  
-Swarthmore A11yGator aims to:  
-- Provide a central hub for students to access accessible course materials.  
-- Ensure compliance with accessibility standards such as WCAG.  
-- Continuously improve functionality and user experience based on user feedback.
+### Tech Stack
 
----
+- **Frontend:**  
+  - Next.js for server-side rendering.  
+  - React for dynamic client-side functionality.  
+- **Backend:**  
+  - tRPC for type-safe API routes without schema duplication.  
+  - Prisma ORM for seamless database interaction.  
+- **Database:** PostgreSQL for reliable and efficient data storage.  
+- **Authentication:** NextAuth.js for secure and simple user authentication.  
+- **Styling:** Tailwind CSS for a clean, responsive, and accessible design.  
+- **Hosting:** Vercel for continuous integration and deployment.  
+- **Storage:** AWS S3 for document storage and management.